2455 lines
85 KiB
C++
2455 lines
85 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) 2015 CERN
|
|
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
|
|
* Copyright (C) 2011 Wayne Stambaugh <[email protected]>
|
|
*
|
|
* Copyright The 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 <common.h> // for PAGE_INFO
|
|
|
|
#include <base_units.h>
|
|
#include <board.h>
|
|
#include <board_design_settings.h>
|
|
#include <component_classes/component_class.h>
|
|
#include <component_classes/component_class_manager.h>
|
|
#include <netinfo.h>
|
|
#include <footprint.h>
|
|
#include <pad.h>
|
|
#include <pcb_group.h>
|
|
#include <pcb_track.h>
|
|
#include <zone.h>
|
|
#include <string_utils.h>
|
|
#include <pcbnew_settings.h>
|
|
#include <pcb_edit_frame.h>
|
|
#include <netlist_reader/pcb_netlist.h>
|
|
#include <connectivity/connectivity_data.h>
|
|
#include <reporter.h>
|
|
#include <wx/log.h>
|
|
|
|
#include "board_netlist_updater.h"
|
|
|
|
|
|
BOARD_NETLIST_UPDATER::BOARD_NETLIST_UPDATER( PCB_EDIT_FRAME* aFrame, BOARD* aBoard ) :
|
|
m_frame( aFrame ),
|
|
m_commit( aFrame ),
|
|
m_board( aBoard )
|
|
{
|
|
m_reporter = &NULL_REPORTER::GetInstance();
|
|
|
|
m_deleteUnusedFootprints = false;
|
|
m_isDryRun = false;
|
|
m_replaceFootprints = true;
|
|
m_lookupByTimestamp = false;
|
|
m_transferGroups = false;
|
|
m_overrideLocks = false;
|
|
m_updateFields = false;
|
|
m_removeExtraFields = false;
|
|
|
|
m_warningCount = 0;
|
|
m_errorCount = 0;
|
|
m_newFootprintsCount = 0;
|
|
}
|
|
|
|
|
|
BOARD_NETLIST_UPDATER::~BOARD_NETLIST_UPDATER()
|
|
{
|
|
}
|
|
|
|
|
|
// These functions allow inspection of pad nets during dry runs by keeping a cache of
|
|
// current pad netnames indexed by pad.
|
|
|
|
void BOARD_NETLIST_UPDATER::cacheNetname( PAD* aPad, const wxString& aNetname )
|
|
{
|
|
m_padNets[ aPad ] = aNetname;
|
|
}
|
|
|
|
|
|
wxString BOARD_NETLIST_UPDATER::getNetname( PAD* aPad )
|
|
{
|
|
if( m_isDryRun && m_padNets.count( aPad ) )
|
|
return m_padNets[ aPad ];
|
|
else
|
|
return aPad->GetNetname();
|
|
}
|
|
|
|
|
|
void BOARD_NETLIST_UPDATER::cachePinFunction( PAD* aPad, const wxString& aPinFunction )
|
|
{
|
|
m_padPinFunctions[ aPad ] = aPinFunction;
|
|
}
|
|
|
|
|
|
wxString BOARD_NETLIST_UPDATER::getPinFunction( PAD* aPad )
|
|
{
|
|
if( m_isDryRun && m_padPinFunctions.count( aPad ) )
|
|
return m_padPinFunctions[ aPad ];
|
|
else
|
|
return aPad->GetPinFunction();
|
|
}
|
|
|
|
|
|
VECTOR2I BOARD_NETLIST_UPDATER::estimateFootprintInsertionPosition()
|
|
{
|
|
VECTOR2I bestPosition;
|
|
|
|
if( !m_board->IsEmpty() )
|
|
{
|
|
// Position new components below any existing board features.
|
|
BOX2I bbox = m_board->GetBoardEdgesBoundingBox();
|
|
|
|
if( bbox.GetWidth() || bbox.GetHeight() )
|
|
{
|
|
bestPosition.x = bbox.Centre().x;
|
|
bestPosition.y = bbox.GetBottom() + pcbIUScale.mmToIU( 10 );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Position new components in the center of the page when the board is empty.
|
|
VECTOR2I pageSize = m_board->GetPageSettings().GetSizeIU( pcbIUScale.IU_PER_MILS );
|
|
|
|
bestPosition.x = pageSize.x / 2;
|
|
bestPosition.y = pageSize.y / 2;
|
|
}
|
|
|
|
return bestPosition;
|
|
}
|
|
|
|
|
|
FOOTPRINT* BOARD_NETLIST_UPDATER::addNewFootprint( COMPONENT* aComponent )
|
|
{
|
|
return addNewFootprint( aComponent, aComponent->GetFPID() );
|
|
}
|
|
|
|
|
|
FOOTPRINT* BOARD_NETLIST_UPDATER::addNewFootprint( COMPONENT* aComponent, const LIB_ID& aFootprintId )
|
|
{
|
|
wxString msg;
|
|
|
|
if( aFootprintId.empty() )
|
|
{
|
|
msg.Printf( _( "Cannot add %s (no footprint assigned)." ),
|
|
aComponent->GetReference() );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
|
|
++m_errorCount;
|
|
return nullptr;
|
|
}
|
|
|
|
FOOTPRINT* footprint = m_frame->LoadFootprint( aFootprintId );
|
|
|
|
if( footprint == nullptr )
|
|
{
|
|
msg.Printf( _( "Cannot add %s (footprint '%s' not found)." ),
|
|
aComponent->GetReference(),
|
|
EscapeHTML( aFootprintId.Format().wx_str() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
|
|
++m_errorCount;
|
|
return nullptr;
|
|
}
|
|
|
|
footprint->SetStaticComponentClass(
|
|
m_board->GetComponentClassManager().GetNoneComponentClass() );
|
|
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Add %s (footprint '%s')." ),
|
|
aComponent->GetReference(),
|
|
EscapeHTML( aFootprintId.Format().wx_str() ) );
|
|
|
|
delete footprint;
|
|
footprint = nullptr;
|
|
}
|
|
else
|
|
{
|
|
for( PAD* pad : footprint->Pads() )
|
|
{
|
|
// Set the pads ratsnest settings to the global settings
|
|
pad->SetLocalRatsnestVisible( m_frame->GetPcbNewSettings()->m_Display.m_ShowGlobalRatsnest );
|
|
|
|
// Pads in the library all have orphaned nets. Replace with Default.
|
|
pad->SetNetCode( 0 );
|
|
}
|
|
|
|
footprint->SetParent( m_board );
|
|
footprint->SetPosition( estimateFootprintInsertionPosition() );
|
|
|
|
// This flag is used to prevent connectivity from considering the footprint during its
|
|
// initial build after the footprint is committed, because we're going to immediately start
|
|
// a move operation on the footprint and don't want its pads to drive nets onto vias/tracks
|
|
// it happens to land on at the initial position.
|
|
footprint->SetAttributes( footprint->GetAttributes() | FP_JUST_ADDED );
|
|
|
|
m_addedFootprints.push_back( footprint );
|
|
m_commit.Add( footprint );
|
|
|
|
msg.Printf( _( "Added %s (footprint '%s')." ),
|
|
aComponent->GetReference(),
|
|
EscapeHTML( aFootprintId.Format().wx_str() ) );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
m_newFootprintsCount++;
|
|
return footprint;
|
|
}
|
|
|
|
|
|
bool BOARD_NETLIST_UPDATER::updateComponentClass( FOOTPRINT* aFootprint, COMPONENT* aNewComponent )
|
|
{
|
|
wxString curClassName, newClassName;
|
|
COMPONENT_CLASS* newClass = nullptr;
|
|
|
|
if( const COMPONENT_CLASS* curClass = aFootprint->GetStaticComponentClass() )
|
|
curClassName = curClass->GetName();
|
|
|
|
// Calculate the new component class
|
|
if( m_isDryRun )
|
|
{
|
|
newClassName = COMPONENT_CLASS_MANAGER::GetFullClassNameForConstituents(
|
|
aNewComponent->GetComponentClassNames() );
|
|
}
|
|
else
|
|
{
|
|
newClass = m_board->GetComponentClassManager().GetEffectiveStaticComponentClass(
|
|
aNewComponent->GetComponentClassNames() );
|
|
newClassName = newClass->GetName();
|
|
}
|
|
|
|
if( curClassName == newClassName )
|
|
return false;
|
|
|
|
// Create a copy for undo if the footprint has not been added during this update
|
|
FOOTPRINT* copy = nullptr;
|
|
|
|
if( !m_isDryRun && !m_commit.GetStatus( aFootprint ) )
|
|
{
|
|
copy = static_cast<FOOTPRINT*>( aFootprint->Clone() );
|
|
copy->SetParentGroup( nullptr );
|
|
}
|
|
|
|
wxString msg;
|
|
|
|
if( m_isDryRun )
|
|
{
|
|
if( curClassName == wxEmptyString && newClassName != wxEmptyString )
|
|
{
|
|
msg.Printf( _( "Change %s component class to '%s'." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( newClassName ) );
|
|
}
|
|
else if( curClassName != wxEmptyString && newClassName == wxEmptyString )
|
|
{
|
|
msg.Printf( _( "Remove %s component class (currently '%s')." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( curClassName ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Change %s component class from '%s' to '%s'." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( curClassName ),
|
|
EscapeHTML( newClassName ) );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
wxASSERT_MSG( newClass != nullptr, "Component class should not be nullptr" );
|
|
|
|
aFootprint->SetStaticComponentClass( newClass );
|
|
|
|
if( curClassName == wxEmptyString && newClassName != wxEmptyString )
|
|
{
|
|
msg.Printf( _( "Changed %s component class to '%s'." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( newClassName ) );
|
|
}
|
|
else if( curClassName != wxEmptyString && newClassName == wxEmptyString )
|
|
{
|
|
msg.Printf( _( "Removed %s component class (was '%s')." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( curClassName ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Changed %s component class from '%s' to '%s'." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( curClassName ),
|
|
EscapeHTML( newClassName ) );
|
|
}
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
|
|
if( copy )
|
|
m_commit.Modified( aFootprint, copy );
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
FOOTPRINT* BOARD_NETLIST_UPDATER::replaceFootprint( NETLIST& aNetlist, FOOTPRINT* aFootprint,
|
|
COMPONENT* aNewComponent )
|
|
{
|
|
wxString msg;
|
|
|
|
if( aNewComponent->GetFPID().empty() )
|
|
{
|
|
msg.Printf( _( "Cannot update %s (no footprint assigned)." ),
|
|
aNewComponent->GetReference() );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
|
|
++m_errorCount;
|
|
return nullptr;
|
|
}
|
|
|
|
FOOTPRINT* newFootprint = m_frame->LoadFootprint( aNewComponent->GetFPID() );
|
|
|
|
if( newFootprint == nullptr )
|
|
{
|
|
msg.Printf( _( "Cannot update %s (footprint '%s' not found)." ),
|
|
aNewComponent->GetReference(),
|
|
EscapeHTML( aNewComponent->GetFPID().Format().wx_str() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
|
|
++m_errorCount;
|
|
return nullptr;
|
|
}
|
|
|
|
if( m_isDryRun )
|
|
{
|
|
if( aFootprint->IsLocked() && !m_overrideLocks )
|
|
{
|
|
msg.Printf( _( "Cannot change %s footprint from '%s' to '%s' (footprint is locked)."),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( aFootprint->GetFPID().Format().wx_str() ),
|
|
EscapeHTML( aNewComponent->GetFPID().Format().wx_str() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_WARNING );
|
|
++m_warningCount;
|
|
delete newFootprint;
|
|
return nullptr;
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Change %s footprint from '%s' to '%s'."),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( aFootprint->GetFPID().Format().wx_str() ),
|
|
EscapeHTML( aNewComponent->GetFPID().Format().wx_str() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
++m_newFootprintsCount;
|
|
delete newFootprint;
|
|
return nullptr;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( aFootprint->IsLocked() && !m_overrideLocks )
|
|
{
|
|
msg.Printf( _( "Could not change %s footprint from '%s' to '%s' (footprint is locked)."),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( aFootprint->GetFPID().Format().wx_str() ),
|
|
EscapeHTML( aNewComponent->GetFPID().Format().wx_str() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_WARNING );
|
|
++m_warningCount;
|
|
delete newFootprint;
|
|
return nullptr;
|
|
}
|
|
else
|
|
{
|
|
// Expand the footprint pad layers
|
|
newFootprint->FixUpPadsForBoard( m_board );
|
|
|
|
m_frame->ExchangeFootprint( aFootprint, newFootprint, m_commit );
|
|
|
|
msg.Printf( _( "Changed %s footprint from '%s' to '%s'."),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( aFootprint->GetFPID().Format().wx_str() ),
|
|
EscapeHTML( aNewComponent->GetFPID().Format().wx_str() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
++m_newFootprintsCount;
|
|
return newFootprint;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
bool BOARD_NETLIST_UPDATER::updateFootprintParameters( FOOTPRINT* aFootprint, COMPONENT* aNetlistComponent )
|
|
{
|
|
wxString msg;
|
|
|
|
const COMPONENT_VARIANT* firstAssociatedVariant = nullptr;
|
|
|
|
if( aFootprint->GetFPID() != aNetlistComponent->GetFPID() )
|
|
{
|
|
for( const auto& [_, test] : aNetlistComponent->GetVariants() )
|
|
{
|
|
if( test.m_fields.count( GetCanonicalFieldName( FIELD_T::FOOTPRINT ) )
|
|
&& aFootprint->GetFPIDAsString() == test.m_fields.at( GetCanonicalFieldName( FIELD_T::FOOTPRINT ) ) )
|
|
{
|
|
firstAssociatedVariant = &test;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Create a copy only if the footprint has not been added during this update
|
|
FOOTPRINT* copy = nullptr;
|
|
|
|
if( !m_commit.GetStatus( aFootprint ) )
|
|
{
|
|
copy = static_cast<FOOTPRINT*>( aFootprint->Clone() );
|
|
copy->SetParentGroup( nullptr );
|
|
}
|
|
|
|
bool changed = false;
|
|
|
|
// Test for reference designator field change.
|
|
if( aFootprint->GetReference() != aNetlistComponent->GetReference() )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Change %s reference designator to %s." ),
|
|
aFootprint->GetReference(),
|
|
aNetlistComponent->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Changed %s reference designator to %s." ),
|
|
aFootprint->GetReference(),
|
|
aNetlistComponent->GetReference() );
|
|
|
|
changed = true;
|
|
aFootprint->SetReference( aNetlistComponent->GetReference() );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
// Test for value field change.
|
|
wxString netlistValue = aNetlistComponent->GetValue();
|
|
|
|
if( firstAssociatedVariant != nullptr
|
|
&& firstAssociatedVariant->m_fields.count( GetCanonicalFieldName( FIELD_T::VALUE ) ) )
|
|
{
|
|
netlistValue = firstAssociatedVariant->m_fields.at( GetCanonicalFieldName( FIELD_T::VALUE ) );
|
|
}
|
|
|
|
if( aFootprint->GetValue() != netlistValue )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Change %s value from %s to %s." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( aFootprint->GetValue() ),
|
|
EscapeHTML( netlistValue ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Changed %s value from %s to %s." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( aFootprint->GetValue() ),
|
|
EscapeHTML( netlistValue ) );
|
|
|
|
changed = true;
|
|
aFootprint->SetValue( netlistValue );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
// Test for time stamp change.
|
|
KIID_PATH new_path = aNetlistComponent->GetPath();
|
|
|
|
if( !aNetlistComponent->GetKIIDs().empty() )
|
|
new_path.push_back( aNetlistComponent->GetKIIDs().front() );
|
|
|
|
if( aFootprint->GetPath() != new_path )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Update %s symbol association from %s to %s." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( aFootprint->GetPath().AsString() ),
|
|
EscapeHTML( new_path.AsString() ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Updated %s symbol association from %s to %s." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( aFootprint->GetPath().AsString() ),
|
|
EscapeHTML( new_path.AsString() ) );
|
|
|
|
changed = true;
|
|
aFootprint->SetPath( new_path );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
nlohmann::ordered_map<wxString, wxString> fpFieldsAsMap;
|
|
|
|
for( PCB_FIELD* field : aFootprint->GetFields() )
|
|
{
|
|
// These fields are individually checked above
|
|
if( field->IsReference() || field->IsValue() || field->IsComponentClass() )
|
|
{
|
|
continue;
|
|
}
|
|
|
|
fpFieldsAsMap[field->GetName()] = field->GetText();
|
|
}
|
|
|
|
// Remove the ref/value/footprint fields that are individually handled
|
|
nlohmann::ordered_map<wxString, wxString> compFields = aNetlistComponent->GetFields();
|
|
compFields.erase( GetCanonicalFieldName( FIELD_T::REFERENCE ) );
|
|
compFields.erase( GetCanonicalFieldName( FIELD_T::VALUE ) );
|
|
compFields.erase( GetCanonicalFieldName( FIELD_T::FOOTPRINT ) );
|
|
|
|
// Remove any component class fields - these are not editable in the pcb editor
|
|
compFields.erase( wxT( "Component Class" ) );
|
|
|
|
if( firstAssociatedVariant != nullptr )
|
|
{
|
|
for( const auto& [name, value] : firstAssociatedVariant->m_fields )
|
|
compFields[name] = value;
|
|
}
|
|
|
|
// Fields are stored as an ordered map, but we don't (yet) support reordering the footprint fields to
|
|
// match the symbol, so we manually check the fields in the order they are stored in the symbol.
|
|
bool same = true;
|
|
bool remove_only = true;
|
|
|
|
for( const auto& [name, value] : compFields )
|
|
{
|
|
if( fpFieldsAsMap.count( name ) == 0 || fpFieldsAsMap[name] != value )
|
|
{
|
|
same = false;
|
|
remove_only = false;
|
|
break;
|
|
}
|
|
}
|
|
|
|
for( const auto& [name, value] : fpFieldsAsMap )
|
|
{
|
|
if( compFields.count( name ) == 0 )
|
|
{
|
|
same = false;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( !same )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
if( m_updateFields && ( !remove_only || m_removeExtraFields ) )
|
|
{
|
|
msg.Printf( _( "Update %s fields." ), aFootprint->GetReference() );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
// Remove fields that aren't present in the symbol
|
|
for( PCB_FIELD* field : aFootprint->GetFields() )
|
|
{
|
|
if( field->IsMandatory() )
|
|
continue;
|
|
|
|
if( compFields.count( field->GetName() ) == 0 )
|
|
{
|
|
if( m_removeExtraFields )
|
|
{
|
|
msg.Printf( _( "Remove %s footprint fields not in symbol." ), aFootprint->GetReference() );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( m_updateFields && ( !remove_only || m_removeExtraFields ) )
|
|
{
|
|
msg.Printf( _( "Updated %s fields." ), aFootprint->GetReference() );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
|
|
changed = true;
|
|
|
|
// Add or change field value
|
|
for( auto& [name, value] : compFields )
|
|
{
|
|
if( aFootprint->HasField( name ) )
|
|
{
|
|
aFootprint->GetField( name )->SetText( value );
|
|
}
|
|
else
|
|
{
|
|
PCB_FIELD* newField = new PCB_FIELD( aFootprint, FIELD_T::USER );
|
|
aFootprint->Add( newField );
|
|
|
|
newField->SetName( name );
|
|
newField->SetText( value );
|
|
newField->SetVisible( false );
|
|
newField->SetLayer( aFootprint->GetLayer() == F_Cu ? F_Fab : B_Fab );
|
|
|
|
// Give the relative position (0,0) in footprint
|
|
newField->SetPosition( aFootprint->GetPosition() );
|
|
// Give the footprint orientation
|
|
newField->Rotate( aFootprint->GetPosition(), aFootprint->GetOrientation() );
|
|
|
|
if( m_frame )
|
|
newField->StyleFromSettings( m_frame->GetDesignSettings(), true );
|
|
}
|
|
}
|
|
}
|
|
|
|
if( m_removeExtraFields )
|
|
{
|
|
bool warned = false;
|
|
|
|
std::vector<PCB_FIELD*> fieldList;
|
|
aFootprint->GetFields( fieldList, false );
|
|
|
|
for( PCB_FIELD* field : fieldList )
|
|
{
|
|
if( field->IsMandatory() )
|
|
continue;
|
|
|
|
if( compFields.count( field->GetName() ) == 0 )
|
|
{
|
|
if( !warned )
|
|
{
|
|
warned = true;
|
|
msg.Printf( _( "Removed %s footprint fields not in symbol." ), aFootprint->GetReference() );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
aFootprint->Remove( field );
|
|
|
|
if( m_frame )
|
|
m_frame->GetCanvas()->GetView()->Remove( field );
|
|
|
|
delete field;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
wxString sheetname;
|
|
wxString sheetfile;
|
|
wxString fpFilters;
|
|
|
|
wxString humanSheetPath = aNetlistComponent->GetHumanReadablePath();
|
|
|
|
if( !humanSheetPath.empty() )
|
|
sheetname = humanSheetPath;
|
|
else if( aNetlistComponent->GetProperties().count( wxT( "Sheetname" ) ) > 0 )
|
|
sheetname = aNetlistComponent->GetProperties().at( wxT( "Sheetname" ) );
|
|
|
|
if( aNetlistComponent->GetProperties().count( wxT( "Sheetfile" ) ) > 0 )
|
|
sheetfile = aNetlistComponent->GetProperties().at( wxT( "Sheetfile" ) );
|
|
|
|
if( aNetlistComponent->GetProperties().count( wxT( "ki_fp_filters" ) ) > 0 )
|
|
fpFilters = aNetlistComponent->GetProperties().at( wxT( "ki_fp_filters" ) );
|
|
|
|
if( sheetname != aFootprint->GetSheetname() )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Update %s sheetname to '%s'." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( sheetname ) );
|
|
}
|
|
else
|
|
{
|
|
aFootprint->SetSheetname( sheetname );
|
|
msg.Printf( _( "Updated %s sheetname to '%s'." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( sheetname ) );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
if( sheetfile != aFootprint->GetSheetfile() )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Update %s sheetfile to '%s'." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( sheetfile ) );
|
|
}
|
|
else
|
|
{
|
|
aFootprint->SetSheetfile( sheetfile );
|
|
msg.Printf( _( "Updated %s sheetfile to '%s'." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( sheetfile ) );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
if( fpFilters != aFootprint->GetFilters() )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Update %s footprint filters to '%s'." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( fpFilters ) );
|
|
}
|
|
else
|
|
{
|
|
aFootprint->SetFilters( fpFilters );
|
|
msg.Printf( _( "Updated %s footprint filters to '%s'." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( fpFilters ) );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
bool netlistExcludeFromBOM = aNetlistComponent->GetProperties().count( wxT( "exclude_from_bom" ) ) > 0;
|
|
|
|
if( firstAssociatedVariant != nullptr && firstAssociatedVariant->m_hasExcludedFromBOM )
|
|
netlistExcludeFromBOM = firstAssociatedVariant->m_excludedFromBOM;
|
|
|
|
if( netlistExcludeFromBOM != ( ( aFootprint->GetAttributes() & FP_EXCLUDE_FROM_BOM ) > 0 ) )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
if( netlistExcludeFromBOM )
|
|
msg.Printf( _( "Add %s 'exclude from BOM' fabrication attribute." ), aFootprint->GetReference() );
|
|
else
|
|
msg.Printf( _( "Remove %s 'exclude from BOM' fabrication attribute." ), aFootprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
int attributes = aFootprint->GetAttributes();
|
|
|
|
if( netlistExcludeFromBOM )
|
|
{
|
|
attributes |= FP_EXCLUDE_FROM_BOM;
|
|
msg.Printf( _( "Added %s 'exclude from BOM' fabrication attribute." ), aFootprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
attributes &= ~FP_EXCLUDE_FROM_BOM;
|
|
msg.Printf( _( "Removed %s 'exclude from BOM' fabrication attribute." ), aFootprint->GetReference() );
|
|
}
|
|
|
|
changed = true;
|
|
aFootprint->SetAttributes( attributes );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
bool netlistDNP = aNetlistComponent->GetProperties().count( wxT( "dnp" ) ) > 0;
|
|
|
|
if( firstAssociatedVariant != nullptr && firstAssociatedVariant->m_hasDnp )
|
|
netlistDNP = firstAssociatedVariant->m_dnp;
|
|
|
|
if( netlistDNP != ( ( aFootprint->GetAttributes() & FP_DNP ) > 0 ) )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
if( netlistDNP )
|
|
msg.Printf( _( "Add %s 'Do not place' fabrication attribute." ), aFootprint->GetReference() );
|
|
else
|
|
msg.Printf( _( "Remove %s 'Do not place' fabrication attribute." ), aFootprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
int attributes = aFootprint->GetAttributes();
|
|
|
|
if( netlistDNP )
|
|
{
|
|
attributes |= FP_DNP;
|
|
msg.Printf( _( "Added %s 'Do not place' fabrication attribute." ), aFootprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
attributes &= ~FP_DNP;
|
|
msg.Printf( _( "Removed %s 'Do not place' fabrication attribute." ), aFootprint->GetReference() );
|
|
}
|
|
|
|
changed = true;
|
|
aFootprint->SetAttributes( attributes );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
bool netlistExcludeFromPosFiles = aNetlistComponent->GetProperties().count( wxT( "exclude_from_pos_files" ) ) > 0;
|
|
|
|
if( firstAssociatedVariant != nullptr && firstAssociatedVariant->m_hasExcludedFromPosFiles )
|
|
netlistExcludeFromPosFiles = firstAssociatedVariant->m_excludedFromPosFiles;
|
|
|
|
if( netlistExcludeFromPosFiles != ( ( aFootprint->GetAttributes() & FP_EXCLUDE_FROM_POS_FILES ) > 0 ) )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
if( netlistExcludeFromPosFiles )
|
|
{
|
|
msg.Printf( _( "Add %s 'exclude from position files' fabrication attribute." ),
|
|
aFootprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Remove %s 'exclude from position files' fabrication attribute." ),
|
|
aFootprint->GetReference() );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
int attributes = aFootprint->GetAttributes();
|
|
|
|
if( netlistExcludeFromPosFiles )
|
|
{
|
|
attributes |= FP_EXCLUDE_FROM_POS_FILES;
|
|
msg.Printf( _( "Added %s 'exclude from position files' fabrication attribute." ),
|
|
aFootprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
attributes &= ~FP_EXCLUDE_FROM_POS_FILES;
|
|
msg.Printf( _( "Removed %s 'exclude from position files' fabrication attribute." ),
|
|
aFootprint->GetReference() );
|
|
}
|
|
|
|
changed = true;
|
|
aFootprint->SetAttributes( attributes );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
if( aNetlistComponent->GetDuplicatePadNumbersAreJumpers()
|
|
!= aFootprint->GetDuplicatePadNumbersAreJumpers() )
|
|
{
|
|
bool value = aNetlistComponent->GetDuplicatePadNumbersAreJumpers();
|
|
|
|
if( !m_isDryRun )
|
|
{
|
|
changed = true;
|
|
aFootprint->SetDuplicatePadNumbersAreJumpers( value );
|
|
|
|
if( value )
|
|
{
|
|
msg.Printf( _( "Added %s 'duplicate pad numbers are jumpers' attribute." ),
|
|
aFootprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Removed %s 'duplicate pad numbers are jumpers' attribute." ),
|
|
aFootprint->GetReference() );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( value )
|
|
{
|
|
msg.Printf( _( "Add %s 'duplicate pad numbers are jumpers' attribute." ),
|
|
aFootprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Remove %s 'duplicate pad numbers are jumpers' attribute." ),
|
|
aFootprint->GetReference() );
|
|
}
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
if( aNetlistComponent->JumperPadGroups() != aFootprint->JumperPadGroups() )
|
|
{
|
|
if( !m_isDryRun )
|
|
{
|
|
changed = true;
|
|
aFootprint->JumperPadGroups() = aNetlistComponent->JumperPadGroups();
|
|
msg.Printf( _( "Updated %s jumper pad groups" ), aFootprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Update %s jumper pad groups" ), aFootprint->GetReference() );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
if( changed && copy )
|
|
m_commit.Modified( aFootprint, copy );
|
|
else
|
|
delete copy;
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool BOARD_NETLIST_UPDATER::updateFootprintGroup( FOOTPRINT* aPcbFootprint,
|
|
COMPONENT* aNetlistComponent )
|
|
{
|
|
if( !m_transferGroups )
|
|
return false;
|
|
|
|
wxString msg;
|
|
|
|
// Create a copy only if the footprint has not been added during this update
|
|
FOOTPRINT* copy = nullptr;
|
|
|
|
if( !m_commit.GetStatus( aPcbFootprint ) )
|
|
{
|
|
copy = static_cast<FOOTPRINT*>( aPcbFootprint->Clone() );
|
|
copy->SetParentGroup( nullptr );
|
|
}
|
|
|
|
bool changed = false;
|
|
|
|
// These hold the info for group and group KIID coming from the netlist
|
|
// newGroup may point to an existing group on the board if we find an
|
|
// incoming group UUID that matches an existing group
|
|
PCB_GROUP* newGroup = nullptr;
|
|
KIID newGroupKIID = aNetlistComponent->GetGroup() ? aNetlistComponent->GetGroup()->uuid : 0;
|
|
|
|
PCB_GROUP* existingGroup = static_cast<PCB_GROUP*>( aPcbFootprint->GetParentGroup() );
|
|
KIID existingGroupKIID = existingGroup ? existingGroup->m_Uuid : 0;
|
|
|
|
// Find existing group based on matching UUIDs
|
|
auto it = std::find_if( m_board->Groups().begin(), m_board->Groups().end(),
|
|
[&](PCB_GROUP* group) {
|
|
return group->m_Uuid == newGroupKIID;
|
|
});
|
|
|
|
// If we find a group with the same UUID, use it
|
|
if( it != m_board->Groups().end() )
|
|
newGroup = *it;
|
|
|
|
// No changes, nothing to do
|
|
if( newGroupKIID == existingGroupKIID )
|
|
return changed;
|
|
|
|
// Remove from existing group
|
|
if( existingGroupKIID != 0 )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Remove %s from group '%s'." ),
|
|
aPcbFootprint->GetReference(),
|
|
EscapeHTML( existingGroup->GetName() ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Removed %s from group '%s'." ),
|
|
aPcbFootprint->GetReference(),
|
|
EscapeHTML( existingGroup->GetName() ) );
|
|
|
|
changed = true;
|
|
m_commit.Modify( existingGroup, nullptr, RECURSE_MODE::NO_RECURSE );
|
|
existingGroup->RemoveItem( aPcbFootprint );
|
|
|
|
if( existingGroup->GetItems().size() < 2 )
|
|
{
|
|
existingGroup->RemoveAll();
|
|
m_commit.Remove( existingGroup );
|
|
}
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
// Add to new group
|
|
if( newGroupKIID != 0 )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Add %s to group '%s'." ),
|
|
aPcbFootprint->GetReference(),
|
|
EscapeHTML( aNetlistComponent->GetGroup()->name ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Added %s to group '%s'." ),
|
|
aPcbFootprint->GetReference(),
|
|
EscapeHTML( aNetlistComponent->GetGroup()->name ) );
|
|
|
|
changed = true;
|
|
|
|
if( newGroup == nullptr )
|
|
{
|
|
newGroup = new PCB_GROUP( m_board );
|
|
const_cast<KIID&>( newGroup->m_Uuid ) = newGroupKIID;
|
|
newGroup->SetName( aNetlistComponent->GetGroup()->name );
|
|
|
|
// Add the group to the board manually so we can find it by checking
|
|
// board groups for later footprints that are checking for existing groups
|
|
m_board->Add( newGroup );
|
|
m_commit.Added( newGroup );
|
|
}
|
|
else
|
|
{
|
|
m_commit.Modify( newGroup->AsEdaItem(), nullptr, RECURSE_MODE::NO_RECURSE );
|
|
}
|
|
|
|
newGroup->AddItem( aPcbFootprint );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
if( changed && copy )
|
|
m_commit.Modified( aPcbFootprint, copy );
|
|
else if( copy )
|
|
delete copy;
|
|
|
|
return changed;
|
|
}
|
|
|
|
|
|
bool BOARD_NETLIST_UPDATER::updateComponentPadConnections( FOOTPRINT* aFootprint,
|
|
COMPONENT* aNewComponent )
|
|
{
|
|
wxString msg;
|
|
|
|
// Create a copy only if the footprint has not been added during this update
|
|
FOOTPRINT* copy = nullptr;
|
|
|
|
if( !m_isDryRun && !m_commit.GetStatus( aFootprint ) )
|
|
{
|
|
copy = static_cast<FOOTPRINT*>( aFootprint->Clone() );
|
|
copy->SetParentGroup( nullptr );
|
|
}
|
|
|
|
bool changed = false;
|
|
|
|
// At this point, the component footprint is updated. Now update the nets.
|
|
std::deque<PAD*> pads = aFootprint->Pads();
|
|
std::set<wxString> padNetnames;
|
|
|
|
std::sort( pads.begin(), pads.end(),
|
|
[]( PAD* a, PAD* b )
|
|
{
|
|
return a->m_Uuid < b->m_Uuid;
|
|
} );
|
|
|
|
for( PAD* pad : pads )
|
|
{
|
|
const COMPONENT_NET& net = aNewComponent->GetNet( pad->GetNumber() );
|
|
|
|
wxLogTrace( wxT( "NETLIST_UPDATE" ),
|
|
wxT( "Processing pad %s of component %s" ),
|
|
pad->GetNumber(),
|
|
aNewComponent->GetReference() );
|
|
|
|
wxString pinFunction;
|
|
wxString pinType;
|
|
|
|
if( net.IsValid() ) // i.e. the pad has a name
|
|
{
|
|
wxLogTrace( wxT( "NETLIST_UPDATE" ),
|
|
wxT( " Found valid net: %s" ),
|
|
net.GetNetName() );
|
|
pinFunction = net.GetPinFunction();
|
|
pinType = net.GetPinType();
|
|
}
|
|
else
|
|
{
|
|
wxLogTrace( wxT( "NETLIST_UPDATE" ),
|
|
wxT( " No net found for pad %s" ),
|
|
pad->GetNumber() );
|
|
}
|
|
|
|
if( !m_isDryRun )
|
|
{
|
|
if( pad->GetPinFunction() != pinFunction )
|
|
{
|
|
changed = true;
|
|
pad->SetPinFunction( pinFunction );
|
|
}
|
|
|
|
if( pad->GetPinType() != pinType )
|
|
{
|
|
changed = true;
|
|
pad->SetPinType( pinType );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
cachePinFunction( pad, pinFunction );
|
|
}
|
|
|
|
// Test if new footprint pad has no net (pads not on copper layers have no net).
|
|
if( !net.IsValid() || !pad->IsOnCopperLayer() )
|
|
{
|
|
if( !pad->GetNetname().IsEmpty() )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Disconnect %s pin %s." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( pad->GetNumber() ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Disconnected %s pin %s." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( pad->GetNumber() ) );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
else if( pad->IsOnCopperLayer() && !pad->GetNumber().IsEmpty() )
|
|
{
|
|
// pad is connectable but has no net found in netlist
|
|
msg.Printf( _( "No net found for component %s pad %s (no pin %s in symbol)." ),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( pad->GetNumber() ),
|
|
EscapeHTML( pad->GetNumber() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_WARNING);
|
|
++m_warningCount;
|
|
}
|
|
|
|
if( !m_isDryRun )
|
|
{
|
|
changed = true;
|
|
pad->SetNetCode( NETINFO_LIST::UNCONNECTED );
|
|
|
|
// If the pad has no net from netlist (i.e. not in netlist
|
|
// it cannot have a pin function
|
|
if( pad->GetNetname().IsEmpty() )
|
|
pad->SetPinFunction( wxEmptyString );
|
|
|
|
}
|
|
else
|
|
{
|
|
cacheNetname( pad, wxEmptyString );
|
|
}
|
|
}
|
|
else // New footprint pad has a net.
|
|
{
|
|
wxString netName = net.GetNetName();
|
|
|
|
if( pad->IsNoConnectPad() )
|
|
{
|
|
netName = wxString::Format( wxS( "%s" ), net.GetNetName() );
|
|
|
|
for( int jj = 1; !padNetnames.insert( netName ).second; jj++ )
|
|
{
|
|
netName = wxString::Format( wxS( "%s_%d" ), net.GetNetName(), jj );
|
|
}
|
|
}
|
|
|
|
NETINFO_ITEM* netinfo = m_board->FindNet( netName );
|
|
|
|
if( netinfo && !m_isDryRun )
|
|
netinfo->SetIsCurrent( true );
|
|
|
|
if( pad->GetNetname() != netName )
|
|
{
|
|
|
|
if( netinfo == nullptr )
|
|
{
|
|
// It might be a new net that has not been added to the board yet
|
|
if( m_addedNets.count( netName ) )
|
|
netinfo = m_addedNets[ netName ];
|
|
}
|
|
|
|
if( netinfo == nullptr )
|
|
{
|
|
netinfo = new NETINFO_ITEM( m_board, netName );
|
|
|
|
// It is a new net, we have to add it
|
|
if( !m_isDryRun )
|
|
{
|
|
changed = true;
|
|
m_commit.Add( netinfo );
|
|
}
|
|
|
|
m_addedNets[netName] = netinfo;
|
|
msg.Printf( _( "Add net %s." ),
|
|
EscapeHTML( UnescapeString( netName ) ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
if( !pad->GetNetname().IsEmpty() )
|
|
{
|
|
m_oldToNewNets[ pad->GetNetname() ] = netName;
|
|
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Reconnect %s pin %s from %s to %s."),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( pad->GetNumber() ),
|
|
EscapeHTML( UnescapeString( pad->GetNetname() ) ),
|
|
EscapeHTML( UnescapeString( netName ) ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Reconnected %s pin %s from %s to %s."),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( pad->GetNumber() ),
|
|
EscapeHTML( UnescapeString( pad->GetNetname() ) ),
|
|
EscapeHTML( UnescapeString( netName ) ) );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Connect %s pin %s to %s."),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( pad->GetNumber() ),
|
|
EscapeHTML( UnescapeString( netName ) ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Connected %s pin %s to %s."),
|
|
aFootprint->GetReference(),
|
|
EscapeHTML( pad->GetNumber() ),
|
|
EscapeHTML( UnescapeString( netName ) ) );
|
|
}
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
|
|
if( !m_isDryRun )
|
|
{
|
|
changed = true;
|
|
pad->SetNet( netinfo );
|
|
}
|
|
else
|
|
{
|
|
cacheNetname( pad, netName );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if( changed && copy )
|
|
m_commit.Modified( aFootprint, copy );
|
|
else if( copy )
|
|
delete copy;
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool BOARD_NETLIST_UPDATER::updateComponentUnits( FOOTPRINT* aFootprint, COMPONENT* aNewComponent )
|
|
{
|
|
// Build the footprint-side representation from the netlist component
|
|
std::vector<FOOTPRINT::FP_UNIT_INFO> newUnits;
|
|
|
|
for( const COMPONENT::UNIT_INFO& u : aNewComponent->GetUnitInfo() )
|
|
newUnits.push_back( { u.m_unitName, u.m_pins } );
|
|
|
|
const std::vector<FOOTPRINT::FP_UNIT_INFO>& curUnits = aFootprint->GetUnitInfo();
|
|
|
|
auto unitsEqual = []( const std::vector<FOOTPRINT::FP_UNIT_INFO>& a,
|
|
const std::vector<FOOTPRINT::FP_UNIT_INFO>& b )
|
|
{
|
|
if( a.size() != b.size() )
|
|
return false;
|
|
|
|
for( size_t i = 0; i < a.size(); ++i )
|
|
{
|
|
if( a[i].m_unitName != b[i].m_unitName )
|
|
return false;
|
|
|
|
if( a[i].m_pins != b[i].m_pins )
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
};
|
|
|
|
if( unitsEqual( curUnits, newUnits ) )
|
|
return false;
|
|
|
|
wxString msg;
|
|
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Update %s unit metadata." ), aFootprint->GetReference() );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
return false; // no actual change on board during dry run
|
|
}
|
|
|
|
// Create a copy only if the footprint has not been added during this update
|
|
FOOTPRINT* copy = nullptr;
|
|
|
|
if( !m_commit.GetStatus( aFootprint ) )
|
|
{
|
|
copy = static_cast<FOOTPRINT*>( aFootprint->Clone() );
|
|
copy->SetParentGroup( nullptr );
|
|
}
|
|
|
|
aFootprint->SetUnitInfo( newUnits );
|
|
|
|
msg.Printf( _( "Updated %s unit metadata." ), aFootprint->GetReference() );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
|
|
if( copy )
|
|
m_commit.Modified( aFootprint, copy );
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void BOARD_NETLIST_UPDATER::applyComponentVariants( COMPONENT* aComponent,
|
|
const std::vector<FOOTPRINT*>& aFootprints,
|
|
const LIB_ID& aBaseFpid )
|
|
{
|
|
wxString msg;
|
|
const auto& variants = aComponent->GetVariants();
|
|
|
|
if( variants.empty() )
|
|
return;
|
|
|
|
if( aBaseFpid.empty() )
|
|
return;
|
|
|
|
const wxString footprintFieldName = GetCanonicalFieldName( FIELD_T::FOOTPRINT );
|
|
|
|
struct VARIANT_INFO
|
|
{
|
|
wxString name;
|
|
const COMPONENT_VARIANT* variant;
|
|
LIB_ID variantFPID;
|
|
};
|
|
|
|
std::vector<VARIANT_INFO> variantInfo;
|
|
variantInfo.reserve( variants.size() );
|
|
|
|
for( const auto& [variantName, variant] : variants )
|
|
{
|
|
LIB_ID variantFPID = aBaseFpid;
|
|
|
|
auto fieldIt = variant.m_fields.find( footprintFieldName );
|
|
|
|
if( fieldIt != variant.m_fields.end() && !fieldIt->second.IsEmpty() )
|
|
{
|
|
LIB_ID parsedId;
|
|
|
|
if( parsedId.Parse( fieldIt->second, true ) >= 0 )
|
|
{
|
|
msg.Printf( _( "Invalid footprint ID '%s' for variant '%s' on %s." ),
|
|
EscapeHTML( fieldIt->second ),
|
|
variantName,
|
|
aComponent->GetReference() );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
|
|
++m_errorCount;
|
|
}
|
|
else
|
|
{
|
|
variantFPID = parsedId;
|
|
}
|
|
}
|
|
|
|
variantInfo.push_back( { variantName, &variant, variantFPID } );
|
|
}
|
|
|
|
for( FOOTPRINT* footprint : aFootprints )
|
|
{
|
|
if( !footprint )
|
|
continue;
|
|
|
|
FOOTPRINT* copy = nullptr;
|
|
|
|
if( !m_isDryRun && !m_commit.GetStatus( footprint ) )
|
|
{
|
|
copy = static_cast<FOOTPRINT*>( footprint->Clone() );
|
|
copy->SetParentGroup( nullptr );
|
|
}
|
|
|
|
bool changed = false;
|
|
|
|
auto printAttributeMessage =
|
|
[&]( bool add, const wxString& attrName, const wxString& variantName )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
if( aFootprints.size() > 1 )
|
|
{
|
|
msg.Printf( add ? _( "Add %s '%s' attribute to variant %s (footprint %s)." )
|
|
: _( "Remove %s '%s' attribute from variant %s (footprint %s)." ),
|
|
footprint->GetReference(),
|
|
attrName,
|
|
variantName,
|
|
footprint->GetFPIDAsString() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( add ? _( "Add %s '%s' attribute to variant %s." )
|
|
: _( "Remove %s '%s' attribute from variant %s." ),
|
|
footprint->GetReference(),
|
|
attrName,
|
|
variantName );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( aFootprints.size() > 1 )
|
|
{
|
|
msg.Printf( add ? _( "Added %s '%s' attribute to variant %s (footprint %s)." )
|
|
: _( "Removed %s '%s' attribute from variant %s (footprint %s)." ),
|
|
footprint->GetReference(),
|
|
attrName,
|
|
variantName,
|
|
footprint->GetFPIDAsString() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( add ? _( "Added %s '%s' attribute to variant %s." )
|
|
: _( "Removed %s '%s' attribute from variant %s." ),
|
|
footprint->GetReference(),
|
|
attrName,
|
|
variantName );
|
|
}
|
|
}
|
|
};
|
|
|
|
std::set<wxString> excessVariants;
|
|
|
|
for( const auto& [variantName, _] : footprint->GetVariants() )
|
|
excessVariants.insert( variantName );
|
|
|
|
for( const VARIANT_INFO& info : variantInfo )
|
|
{
|
|
const COMPONENT_VARIANT& variant = *info.variant;
|
|
|
|
// During dry run, just read current state. During actual run, create variant if needed.
|
|
const FOOTPRINT_VARIANT* currentVariant = footprint->GetVariant( info.name );
|
|
|
|
// Check if this footprint is the active one for this variant
|
|
bool isAssociatedFootprint = ( footprint->GetFPID() == info.variantFPID );
|
|
|
|
// If this footprint is not active for this variant, it doesn't need variant info for it.
|
|
// Otherwise, apply explicit overrides from schematic, or reset to base footprint value.
|
|
|
|
if( !isAssociatedFootprint )
|
|
continue;
|
|
|
|
excessVariants.erase( info.name );
|
|
bool targetDnp = variant.m_hasDnp ? variant.m_dnp : footprint->IsDNP();
|
|
bool currentDnp = currentVariant ? currentVariant->GetDNP() : footprint->IsDNP();
|
|
|
|
if( currentDnp != targetDnp )
|
|
{
|
|
printAttributeMessage( targetDnp, _( "Do not place" ), info.name );
|
|
|
|
if( !m_isDryRun )
|
|
{
|
|
if( FOOTPRINT_VARIANT* fpVariant = footprint->AddVariant( info.name ) )
|
|
fpVariant->SetDNP( targetDnp );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
changed = true;
|
|
}
|
|
|
|
bool targetExcludedFromBOM = variant.m_hasExcludedFromBOM ? variant.m_excludedFromBOM
|
|
: footprint->IsExcludedFromBOM();
|
|
bool currentExcludedFromBOM = currentVariant ? currentVariant->GetExcludedFromBOM()
|
|
: footprint->IsExcludedFromBOM();
|
|
|
|
if( currentExcludedFromBOM != targetExcludedFromBOM )
|
|
{
|
|
printAttributeMessage( targetExcludedFromBOM, _( "exclude from BOM" ), info.name );
|
|
|
|
if( !m_isDryRun )
|
|
{
|
|
if( FOOTPRINT_VARIANT* fpVariant = footprint->AddVariant( info.name ) )
|
|
fpVariant->SetExcludedFromBOM( targetExcludedFromBOM );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
changed = true;
|
|
}
|
|
|
|
bool targetExcludedFromPosFiles = variant.m_hasExcludedFromPosFiles ? variant.m_excludedFromPosFiles
|
|
: footprint->IsExcludedFromPosFiles();
|
|
bool currentExcludedFromPosFiles = currentVariant ? currentVariant->GetExcludedFromPosFiles()
|
|
: footprint->IsExcludedFromPosFiles();
|
|
|
|
if( currentExcludedFromPosFiles != targetExcludedFromPosFiles )
|
|
{
|
|
printAttributeMessage( targetExcludedFromPosFiles, _( "exclude from position files" ), info.name );
|
|
|
|
if( !m_isDryRun )
|
|
{
|
|
if( FOOTPRINT_VARIANT* fpVariant = footprint->AddVariant( info.name ) )
|
|
fpVariant->SetExcludedFromPosFiles( targetExcludedFromPosFiles );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
changed = true;
|
|
}
|
|
|
|
for( const auto& [fieldName, fieldValue] : variant.m_fields )
|
|
{
|
|
if( fieldName.CmpNoCase( footprintFieldName ) == 0 )
|
|
continue;
|
|
|
|
bool hasCurrentValue = currentVariant && currentVariant->HasFieldValue( fieldName );
|
|
wxString currentValue = hasCurrentValue ? currentVariant->GetFieldValue( fieldName ) : wxString();
|
|
|
|
if( currentValue != fieldValue )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
if( aFootprints.size() > 1 )
|
|
{
|
|
msg.Printf( _( "Change %s field '%s' to '%s' on variant %s (footprint %s)." ),
|
|
footprint->GetReference(),
|
|
fieldName,
|
|
fieldValue,
|
|
info.name,
|
|
footprint->GetFPIDAsString() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Change %s field '%s' to '%s' on variant %s." ),
|
|
footprint->GetReference(),
|
|
fieldName,
|
|
fieldValue,
|
|
info.name );
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( aFootprints.size() > 1 )
|
|
{
|
|
msg.Printf( _( "Changed %s field '%s' to '%s' on variant %s (footprint %s)." ),
|
|
footprint->GetReference(),
|
|
fieldName,
|
|
fieldValue,
|
|
info.name,
|
|
footprint->GetFPIDAsString() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Changed %s field '%s' to '%s' on variant %s." ),
|
|
footprint->GetReference(),
|
|
fieldName,
|
|
fieldValue,
|
|
info.name );
|
|
}
|
|
|
|
if( FOOTPRINT_VARIANT* fpVariant = footprint->AddVariant( info.name ) )
|
|
fpVariant->SetFieldValue( fieldName, fieldValue );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
changed = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
for( const wxString& excess : excessVariants )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Remove variant %s:%s no longer associated with footprint %s." ),
|
|
footprint->GetReference(),
|
|
excess,
|
|
footprint->GetFPIDAsString() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Removed variant %s:%s no longer associated with footprint %s." ),
|
|
footprint->GetReference(),
|
|
excess,
|
|
footprint->GetFPIDAsString() );
|
|
|
|
footprint->DeleteVariant( excess );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
changed = true;
|
|
}
|
|
|
|
// For the default variant: if this footprint is not the base footprint
|
|
// it should be DNP by default
|
|
bool isBaseFootprint = ( footprint->GetFPID() == aBaseFpid );
|
|
|
|
if( !isBaseFootprint && !footprint->IsDNP() )
|
|
{
|
|
msg.Printf( m_isDryRun ? _( "Add %s 'Do not place' fabrication attribute." )
|
|
: _( "Added %s 'Do not place' fabrication attribute." ),
|
|
footprint->GetReference() );
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
|
|
if( !m_isDryRun )
|
|
footprint->SetDNP( true );
|
|
|
|
changed = true;
|
|
}
|
|
|
|
if( !m_isDryRun && changed && copy )
|
|
m_commit.Modified( footprint, copy );
|
|
else
|
|
delete copy;
|
|
}
|
|
}
|
|
|
|
|
|
void BOARD_NETLIST_UPDATER::cacheCopperZoneConnections()
|
|
{
|
|
for( ZONE* zone : m_board->Zones() )
|
|
{
|
|
if( !zone->IsOnCopperLayer() || zone->GetIsRuleArea() )
|
|
continue;
|
|
|
|
m_zoneConnectionsCache[ zone ] = m_board->GetConnectivity()->GetConnectedPads( zone );
|
|
}
|
|
}
|
|
|
|
|
|
bool BOARD_NETLIST_UPDATER::updateCopperZoneNets( NETLIST& aNetlist )
|
|
{
|
|
wxString msg;
|
|
std::set<wxString> netlistNetnames;
|
|
|
|
for( int ii = 0; ii < (int) aNetlist.GetCount(); ii++ )
|
|
{
|
|
const COMPONENT* component = aNetlist.GetComponent( ii );
|
|
|
|
for( unsigned jj = 0; jj < component->GetNetCount(); jj++ )
|
|
{
|
|
const COMPONENT_NET& net = component->GetNet( jj );
|
|
netlistNetnames.insert( net.GetNetName() );
|
|
}
|
|
}
|
|
|
|
for( PCB_TRACK* via : m_board->Tracks() )
|
|
{
|
|
if( via->Type() != PCB_VIA_T )
|
|
continue;
|
|
|
|
if( netlistNetnames.count( via->GetNetname() ) == 0 )
|
|
{
|
|
wxString updatedNetname = wxEmptyString;
|
|
|
|
// Take via name from name change map if it didn't match to a new pad
|
|
// (this is useful for stitching vias that don't connect to tracks)
|
|
if( m_oldToNewNets.count( via->GetNetname() ) )
|
|
{
|
|
updatedNetname = m_oldToNewNets[via->GetNetname()];
|
|
}
|
|
|
|
if( !updatedNetname.IsEmpty() )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
wxString originalNetname = via->GetNetname();
|
|
|
|
msg.Printf( _( "Reconnect via from %s to %s." ),
|
|
EscapeHTML( UnescapeString( originalNetname ) ),
|
|
EscapeHTML( UnescapeString( updatedNetname ) ) );
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
else
|
|
{
|
|
NETINFO_ITEM* netinfo = m_board->FindNet( updatedNetname );
|
|
|
|
if( !netinfo )
|
|
netinfo = m_addedNets[updatedNetname];
|
|
|
|
if( netinfo )
|
|
{
|
|
wxString originalNetname = via->GetNetname();
|
|
|
|
m_commit.Modify( via );
|
|
via->SetNet( netinfo );
|
|
|
|
msg.Printf( _( "Reconnected via from %s to %s." ),
|
|
EscapeHTML( UnescapeString( originalNetname ) ),
|
|
EscapeHTML( UnescapeString( updatedNetname ) ) );
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Via connected to unknown net (%s)." ),
|
|
EscapeHTML( UnescapeString( via->GetNetname() ) ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_WARNING );
|
|
++m_warningCount;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Board connectivity net names are not the same as schematic connectivity net names.
|
|
// Footprints that contain multiple overlapping pads with the same number are suffixed
|
|
// with "_N" for internal use. Somewhere along the line, these pseudo net names were
|
|
// exposed in the zone net name list.
|
|
auto isInNetlist = [&]( const wxString& aNetName ) -> bool
|
|
{
|
|
if( netlistNetnames.count( aNetName ) )
|
|
return true;
|
|
|
|
// If the zone net name is a pseudo net name, check if the root net name is in the net
|
|
// list. If so, then this is a valid net.
|
|
for( const wxString& netName : netlistNetnames )
|
|
{
|
|
if( aNetName.StartsWith( netName ) )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
};
|
|
|
|
// Test copper zones to detect "dead" nets (nets without any pad):
|
|
for( ZONE* zone : m_board->Zones() )
|
|
{
|
|
if( !zone->IsOnCopperLayer() || zone->GetIsRuleArea() )
|
|
continue;
|
|
|
|
if( !isInNetlist( zone->GetNetname() ) )
|
|
{
|
|
// Look for a pad in the zone's connected-pad-cache which has been updated to
|
|
// a new net and use that. While this won't always be the right net, the dead
|
|
// net is guaranteed to be wrong.
|
|
wxString updatedNetname = wxEmptyString;
|
|
|
|
for( PAD* pad : m_zoneConnectionsCache[ zone ] )
|
|
{
|
|
if( getNetname( pad ) != zone->GetNetname() )
|
|
{
|
|
updatedNetname = getNetname( pad );
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Take zone name from name change map if it didn't match to a new pad
|
|
// (this is useful for zones on internal layers)
|
|
if( updatedNetname.IsEmpty() && m_oldToNewNets.count( zone->GetNetname() ) )
|
|
{
|
|
updatedNetname = m_oldToNewNets[ zone->GetNetname() ];
|
|
}
|
|
|
|
if( !updatedNetname.IsEmpty() )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
wxString originalNetname = zone->GetNetname();
|
|
|
|
if( !zone->GetZoneName().IsEmpty() )
|
|
{
|
|
msg.Printf( _( "Reconnect copper zone '%s' from %s to %s." ),
|
|
zone->GetZoneName(),
|
|
EscapeHTML( UnescapeString( originalNetname ) ),
|
|
EscapeHTML( UnescapeString( updatedNetname ) ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Reconnect copper zone from %s to %s." ),
|
|
EscapeHTML( UnescapeString( originalNetname ) ),
|
|
EscapeHTML( UnescapeString( updatedNetname ) ) );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
else
|
|
{
|
|
NETINFO_ITEM* netinfo = m_board->FindNet( updatedNetname );
|
|
|
|
if( !netinfo )
|
|
netinfo = m_addedNets[ updatedNetname ];
|
|
|
|
if( netinfo )
|
|
{
|
|
wxString originalNetname = zone->GetNetname();
|
|
|
|
m_commit.Modify( zone );
|
|
zone->SetNet( netinfo );
|
|
|
|
if( !zone->GetZoneName().IsEmpty() )
|
|
{
|
|
msg.Printf( _( "Reconnected copper zone '%s' from %s to %s." ),
|
|
EscapeHTML( zone->GetZoneName() ),
|
|
EscapeHTML( UnescapeString( originalNetname ) ),
|
|
EscapeHTML( UnescapeString( updatedNetname ) ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Reconnected copper zone from %s to %s." ),
|
|
EscapeHTML( UnescapeString( originalNetname ) ),
|
|
EscapeHTML( UnescapeString( updatedNetname ) ) );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if( !zone->GetZoneName().IsEmpty() )
|
|
{
|
|
msg.Printf( _( "Copper zone '%s' has no pads connected." ),
|
|
EscapeHTML( zone->GetZoneName() ) );
|
|
}
|
|
else
|
|
{
|
|
wxString layerNames = zone->LayerMaskDescribe();
|
|
VECTOR2I pt = zone->GetPosition();
|
|
|
|
if( m_frame && m_frame->GetPcbNewSettings() )
|
|
{
|
|
if( m_frame->GetPcbNewSettings()->m_Display.m_DisplayInvertXAxis )
|
|
pt.x *= -1;
|
|
|
|
if( m_frame->GetPcbNewSettings()->m_Display.m_DisplayInvertYAxis )
|
|
pt.y *= -1;
|
|
}
|
|
|
|
msg.Printf( _( "Copper zone on %s at (%s, %s) has no pads connected to net \"%s\"." ),
|
|
EscapeHTML( layerNames ),
|
|
m_frame ? m_frame->MessageTextFromValue( pt.x )
|
|
: EDA_UNIT_UTILS::UI::MessageTextFromValue( pcbIUScale, EDA_UNITS::MM, pt.x ),
|
|
m_frame ? m_frame->MessageTextFromValue( pt.y )
|
|
: EDA_UNIT_UTILS::UI::MessageTextFromValue( pcbIUScale, EDA_UNITS::MM, pt.y ),
|
|
zone->GetNetname() );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_WARNING );
|
|
++m_warningCount;
|
|
}
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool BOARD_NETLIST_UPDATER::updateGroups( NETLIST& aNetlist )
|
|
{
|
|
if( !m_transferGroups )
|
|
return false;
|
|
|
|
wxString msg;
|
|
|
|
for( PCB_GROUP* pcbGroup : m_board->Groups() )
|
|
{
|
|
NETLIST_GROUP* netlistGroup = aNetlist.GetGroupByUuid( pcbGroup->m_Uuid );
|
|
|
|
if( netlistGroup == nullptr )
|
|
continue;
|
|
|
|
if( netlistGroup->name != pcbGroup->GetName() )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Change group name from '%s' to '%s'." ),
|
|
EscapeHTML( pcbGroup->GetName() ),
|
|
EscapeHTML( netlistGroup->name ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Changed group name from '%s' to '%s'." ),
|
|
EscapeHTML( pcbGroup->GetName() ),
|
|
EscapeHTML( netlistGroup->name ) );
|
|
m_commit.Modify( pcbGroup->AsEdaItem(), nullptr, RECURSE_MODE::NO_RECURSE );
|
|
pcbGroup->SetName( netlistGroup->name );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
if( netlistGroup->libId != pcbGroup->GetDesignBlockLibId() )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Change group library link from '%s' to '%s'." ),
|
|
EscapeHTML( pcbGroup->GetDesignBlockLibId().GetUniStringLibId() ),
|
|
EscapeHTML( netlistGroup->libId.GetUniStringLibId() ) );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Changed group library link from '%s' to '%s'." ),
|
|
EscapeHTML( pcbGroup->GetDesignBlockLibId().GetUniStringLibId() ),
|
|
EscapeHTML( netlistGroup->libId.GetUniStringLibId() ) );
|
|
m_commit.Modify( pcbGroup->AsEdaItem(), nullptr, RECURSE_MODE::NO_RECURSE );
|
|
pcbGroup->SetDesignBlockLibId( netlistGroup->libId );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool BOARD_NETLIST_UPDATER::testConnectivity( NETLIST& aNetlist,
|
|
std::map<COMPONENT*, FOOTPRINT*>& aFootprintMap )
|
|
{
|
|
// Verify that board contains all pads in netlist: if it doesn't then footprints are
|
|
// wrong or missing.
|
|
|
|
wxString msg;
|
|
wxString padNumber;
|
|
|
|
for( int i = 0; i < (int) aNetlist.GetCount(); i++ )
|
|
{
|
|
COMPONENT* component = aNetlist.GetComponent( i );
|
|
FOOTPRINT* footprint = aFootprintMap[component];
|
|
|
|
if( !footprint ) // It can be missing in partial designs
|
|
continue;
|
|
|
|
// Explore all pins/pads in component
|
|
for( unsigned jj = 0; jj < component->GetNetCount(); jj++ )
|
|
{
|
|
padNumber = component->GetNet( jj ).GetPinName();
|
|
|
|
if( padNumber.IsEmpty() )
|
|
{
|
|
// bad symbol, report error
|
|
msg.Printf( _( "Symbol %s has pins with no number. These pins can not be matched "
|
|
"to pads in %s." ),
|
|
component->GetReference(),
|
|
EscapeHTML( footprint->GetFPID().Format().wx_str() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
|
|
++m_errorCount;
|
|
}
|
|
else if( !footprint->FindPadByNumber( padNumber ) )
|
|
{
|
|
// not found: bad footprint, report error
|
|
msg.Printf( _( "%s pad %s not found in %s." ),
|
|
component->GetReference(),
|
|
EscapeHTML( padNumber ),
|
|
EscapeHTML( footprint->GetFPID().Format().wx_str() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
|
|
++m_errorCount;
|
|
}
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool BOARD_NETLIST_UPDATER::UpdateNetlist( NETLIST& aNetlist )
|
|
{
|
|
FOOTPRINT* lastPreexistingFootprint = nullptr;
|
|
COMPONENT* component = nullptr;
|
|
wxString msg;
|
|
std::unordered_set<wxString> sheetPaths;
|
|
std::unordered_set<FOOTPRINT*> usedFootprints;
|
|
|
|
m_errorCount = 0;
|
|
m_warningCount = 0;
|
|
m_newFootprintsCount = 0;
|
|
|
|
std::map<COMPONENT*, FOOTPRINT*> footprintMap;
|
|
|
|
if( !m_board->Footprints().empty() )
|
|
lastPreexistingFootprint = m_board->Footprints().back();
|
|
|
|
cacheCopperZoneConnections();
|
|
|
|
// First mark all nets (except <no net>) as stale; we'll update those which are current
|
|
// in the following two loops. Also prepare the component class manager for updates.
|
|
//
|
|
if( !m_isDryRun )
|
|
{
|
|
for( NETINFO_ITEM* net : m_board->GetNetInfo() )
|
|
net->SetIsCurrent( net->GetNetCode() == 0 );
|
|
|
|
m_board->GetComponentClassManager().InitNetlistUpdate();
|
|
}
|
|
|
|
// Next go through the netlist updating all board footprints which have matching component
|
|
// entries and adding new footprints for those that don't.
|
|
//
|
|
for( unsigned i = 0; i < aNetlist.GetCount(); i++ )
|
|
{
|
|
component = aNetlist.GetComponent( i );
|
|
|
|
if( component->GetProperties().count( wxT( "exclude_from_board" ) ) )
|
|
continue;
|
|
|
|
msg.Printf( _( "Processing symbol '%s:%s'." ),
|
|
component->GetReference(),
|
|
EscapeHTML( component->GetFPID().Format().wx_str() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_INFO );
|
|
|
|
const LIB_ID& baseFpid = component->GetFPID();
|
|
const bool hasBaseFpid = !baseFpid.empty();
|
|
|
|
if( baseFpid.IsLegacy() )
|
|
{
|
|
msg.Printf( _( "Warning: %s footprint '%s' is missing a library name. "
|
|
"Use the full 'Library:Footprint' format to avoid repeated update "
|
|
"notifications." ),
|
|
component->GetReference(),
|
|
EscapeHTML( baseFpid.Format().wx_str() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_WARNING );
|
|
++m_warningCount;
|
|
}
|
|
|
|
std::vector<FOOTPRINT*> matchingFootprints;
|
|
|
|
for( FOOTPRINT* footprint : m_board->Footprints() )
|
|
{
|
|
bool match = false;
|
|
|
|
if( m_lookupByTimestamp )
|
|
{
|
|
for( const KIID& uuid : component->GetKIIDs() )
|
|
{
|
|
KIID_PATH base = component->GetPath();
|
|
base.push_back( uuid );
|
|
|
|
if( footprint->GetPath() == base )
|
|
{
|
|
match = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
match = footprint->GetReference().CmpNoCase( component->GetReference() ) == 0;
|
|
}
|
|
|
|
if( match )
|
|
matchingFootprints.push_back( footprint );
|
|
|
|
if( footprint == lastPreexistingFootprint )
|
|
{
|
|
// No sense going through the newly-created footprints: end of loop
|
|
break;
|
|
}
|
|
}
|
|
|
|
std::vector<LIB_ID> expectedFpids;
|
|
std::unordered_set<wxString> expectedFpidKeys;
|
|
|
|
auto addExpectedFpid =
|
|
[&]( const LIB_ID& aFpid )
|
|
{
|
|
if( aFpid.empty() )
|
|
return;
|
|
|
|
wxString key = aFpid.Format();
|
|
|
|
if( expectedFpidKeys.insert( key ).second )
|
|
expectedFpids.push_back( aFpid );
|
|
};
|
|
|
|
addExpectedFpid( baseFpid );
|
|
|
|
const wxString footprintFieldName = GetCanonicalFieldName( FIELD_T::FOOTPRINT );
|
|
|
|
for( const auto& [variantName, variant] : component->GetVariants() )
|
|
{
|
|
auto fieldIt = variant.m_fields.find( footprintFieldName );
|
|
|
|
if( fieldIt == variant.m_fields.end() || fieldIt->second.IsEmpty() )
|
|
continue;
|
|
|
|
LIB_ID parsedId;
|
|
|
|
if( parsedId.Parse( fieldIt->second, true ) >= 0 )
|
|
{
|
|
msg.Printf( _( "Invalid footprint ID '%s' for variant '%s' on %s." ),
|
|
EscapeHTML( fieldIt->second ),
|
|
variantName,
|
|
component->GetReference() );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ERROR );
|
|
++m_errorCount;
|
|
continue;
|
|
}
|
|
|
|
addExpectedFpid( parsedId );
|
|
}
|
|
|
|
// When the schematic-side FPID has no library nickname (legacy format like
|
|
// "DGG56" instead of "Package_SO:DGG56"), matching should compare only the
|
|
// footprint item name. Otherwise the board footprint (which always has a library
|
|
// nickname) will never match, causing perpetual "change footprint" notifications.
|
|
auto fpidMatches =
|
|
[&]( const LIB_ID& aBoardFpid, const LIB_ID& aExpectedFpid ) -> bool
|
|
{
|
|
if( aExpectedFpid.IsLegacy() )
|
|
return aBoardFpid.GetLibItemName() == aExpectedFpid.GetLibItemName();
|
|
|
|
return aBoardFpid == aExpectedFpid;
|
|
};
|
|
|
|
auto isExpectedFpid =
|
|
[&]( const LIB_ID& aFpid ) -> bool
|
|
{
|
|
if( aFpid.empty() )
|
|
return false;
|
|
|
|
if( expectedFpidKeys.count( aFpid.Format() ) > 0 )
|
|
return true;
|
|
|
|
for( const LIB_ID& expected : expectedFpids )
|
|
{
|
|
if( fpidMatches( aFpid, expected ) )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
};
|
|
|
|
auto takeMatchingFootprint =
|
|
[&]( const LIB_ID& aFpid ) -> FOOTPRINT*
|
|
{
|
|
for( FOOTPRINT* footprint : matchingFootprints )
|
|
{
|
|
if( usedFootprints.count( footprint ) )
|
|
continue;
|
|
|
|
if( fpidMatches( footprint->GetFPID(), aFpid ) )
|
|
return footprint;
|
|
}
|
|
|
|
return nullptr;
|
|
};
|
|
|
|
std::vector<FOOTPRINT*> componentFootprints;
|
|
componentFootprints.reserve( expectedFpids.size() );
|
|
FOOTPRINT* baseFootprint = nullptr;
|
|
|
|
if( hasBaseFpid )
|
|
baseFootprint = takeMatchingFootprint( baseFpid );
|
|
else if( !matchingFootprints.empty() )
|
|
baseFootprint = matchingFootprints.front();
|
|
|
|
if( !baseFootprint && m_replaceFootprints && !matchingFootprints.empty() )
|
|
{
|
|
FOOTPRINT* replaceCandidate = nullptr;
|
|
|
|
for( FOOTPRINT* footprint : matchingFootprints )
|
|
{
|
|
if( usedFootprints.count( footprint ) )
|
|
continue;
|
|
|
|
if( isExpectedFpid( footprint->GetFPID() ) )
|
|
continue;
|
|
|
|
replaceCandidate = footprint;
|
|
break;
|
|
}
|
|
|
|
if( replaceCandidate )
|
|
{
|
|
FOOTPRINT* replaced = replaceFootprint( aNetlist, replaceCandidate, component );
|
|
|
|
if( replaced )
|
|
baseFootprint = replaced;
|
|
else
|
|
baseFootprint = replaceCandidate;
|
|
}
|
|
}
|
|
|
|
if( !baseFootprint && hasBaseFpid )
|
|
baseFootprint = addNewFootprint( component, baseFpid );
|
|
|
|
if( baseFootprint )
|
|
{
|
|
componentFootprints.push_back( baseFootprint );
|
|
usedFootprints.insert( baseFootprint );
|
|
footprintMap[ component ] = baseFootprint;
|
|
}
|
|
|
|
for( const LIB_ID& fpid : expectedFpids )
|
|
{
|
|
if( fpid == baseFpid )
|
|
continue;
|
|
|
|
FOOTPRINT* footprint = takeMatchingFootprint( fpid );
|
|
|
|
if( !footprint )
|
|
footprint = addNewFootprint( component, fpid );
|
|
|
|
if( footprint )
|
|
{
|
|
componentFootprints.push_back( footprint );
|
|
usedFootprints.insert( footprint );
|
|
}
|
|
}
|
|
|
|
for( FOOTPRINT* footprint : componentFootprints )
|
|
{
|
|
if( !footprint )
|
|
continue;
|
|
|
|
updateFootprintParameters( footprint, component );
|
|
updateFootprintGroup( footprint, component );
|
|
updateComponentPadConnections( footprint, component );
|
|
updateComponentClass( footprint, component );
|
|
updateComponentUnits( footprint, component );
|
|
|
|
sheetPaths.insert( footprint->GetSheetname() );
|
|
}
|
|
|
|
if( !componentFootprints.empty() )
|
|
applyComponentVariants( component, componentFootprints, baseFpid );
|
|
}
|
|
|
|
updateCopperZoneNets( aNetlist );
|
|
updateGroups( aNetlist );
|
|
|
|
// Finally go through the board footprints and update all those that *don't* have matching
|
|
// component entries.
|
|
//
|
|
for( FOOTPRINT* footprint : m_board->Footprints() )
|
|
{
|
|
bool matched = false;
|
|
bool doDelete = m_deleteUnusedFootprints;
|
|
|
|
if( ( footprint->GetAttributes() & FP_BOARD_ONLY ) > 0 )
|
|
doDelete = false;
|
|
|
|
bool isStaleVariantFootprint = false;
|
|
|
|
if( usedFootprints.count( footprint ) )
|
|
{
|
|
matched = true;
|
|
}
|
|
else
|
|
{
|
|
if( m_lookupByTimestamp )
|
|
component = aNetlist.GetComponentByPath( footprint->GetPath() );
|
|
else
|
|
component = aNetlist.GetComponentByReference( footprint->GetReference() );
|
|
|
|
if( component && component->GetProperties().count( wxT( "exclude_from_board" ) ) == 0 )
|
|
{
|
|
// When replace footprints is enabled and a component has variant footprints,
|
|
// footprints matching by reference but not in usedFootprints are stale variant
|
|
// footprints that should be replaced/removed.
|
|
if( m_replaceFootprints && !component->GetVariants().empty() )
|
|
{
|
|
matched = false;
|
|
isStaleVariantFootprint = true;
|
|
}
|
|
else
|
|
{
|
|
matched = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Stale variant footprints should be deleted when m_replaceFootprints is enabled,
|
|
// regardless of m_deleteUnusedFootprints setting.
|
|
if( isStaleVariantFootprint )
|
|
doDelete = true;
|
|
|
|
if( doDelete && !matched && footprint->IsLocked() && !m_overrideLocks )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Cannot remove unused footprint %s (footprint is locked)." ),
|
|
footprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
msg.Printf( _( "Could not remove unused footprint %s (footprint is locked)." ),
|
|
footprint->GetReference() );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_WARNING );
|
|
m_warningCount++;
|
|
doDelete = false;
|
|
}
|
|
|
|
if( doDelete && !matched )
|
|
{
|
|
if( m_isDryRun )
|
|
{
|
|
msg.Printf( _( "Remove unused footprint %s." ),
|
|
footprint->GetReference() );
|
|
}
|
|
else
|
|
{
|
|
m_commit.Remove( footprint );
|
|
msg.Printf( _( "Removed unused footprint %s." ),
|
|
footprint->GetReference() );
|
|
}
|
|
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
else if( !m_isDryRun )
|
|
{
|
|
if( !matched )
|
|
footprint->SetPath( KIID_PATH() );
|
|
|
|
for( PAD* pad : footprint->Pads() )
|
|
{
|
|
if( pad->GetNet() )
|
|
pad->GetNet()->SetIsCurrent( true );
|
|
}
|
|
}
|
|
}
|
|
|
|
if( !m_isDryRun )
|
|
{
|
|
// Finalise the component class manager
|
|
m_board->GetComponentClassManager().FinishNetlistUpdate();
|
|
m_board->SynchronizeComponentClasses( sheetPaths );
|
|
|
|
m_board->BuildConnectivity();
|
|
testConnectivity( aNetlist, footprintMap );
|
|
|
|
for( NETINFO_ITEM* net : m_board->GetNetInfo() )
|
|
{
|
|
if( !net->IsCurrent() )
|
|
{
|
|
msg.Printf( _( "Removed unused net %s." ),
|
|
EscapeHTML( net->GetNetname() ) );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
}
|
|
|
|
m_board->RemoveUnusedNets( &m_commit );
|
|
|
|
// Update board variant registry from netlist
|
|
const std::vector<wxString>& netlistVariants = aNetlist.GetVariantNames();
|
|
|
|
if( !netlistVariants.empty() || !m_board->GetVariantNames().empty() )
|
|
{
|
|
m_reporter->Report( _( "Updating design variants..." ), RPT_SEVERITY_INFO );
|
|
|
|
auto findBoardVariantName =
|
|
[&]( const wxString& aVariantName ) -> wxString
|
|
{
|
|
for( const wxString& name : m_board->GetVariantNames() )
|
|
{
|
|
if( name.CmpNoCase( aVariantName ) == 0 )
|
|
return name;
|
|
}
|
|
|
|
return wxEmptyString;
|
|
};
|
|
|
|
std::vector<wxString> updatedVariantNames;
|
|
updatedVariantNames.reserve( netlistVariants.size() );
|
|
|
|
for( const wxString& variantName : netlistVariants )
|
|
{
|
|
wxString actualName = findBoardVariantName( variantName );
|
|
|
|
if( actualName.IsEmpty() )
|
|
{
|
|
m_board->AddVariant( variantName );
|
|
actualName = findBoardVariantName( variantName );
|
|
|
|
if( !actualName.IsEmpty() )
|
|
{
|
|
msg.Printf( _( "Added variant '%s'." ), actualName );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
}
|
|
|
|
if( actualName.IsEmpty() )
|
|
continue;
|
|
|
|
// Update description if changed
|
|
wxString newDescription = aNetlist.GetVariantDescription( variantName );
|
|
wxString oldDescription = m_board->GetVariantDescription( actualName );
|
|
|
|
if( newDescription != oldDescription )
|
|
{
|
|
m_board->SetVariantDescription( actualName, newDescription );
|
|
msg.Printf( _( "Updated description for variant '%s'." ), actualName );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
updatedVariantNames.push_back( actualName );
|
|
}
|
|
|
|
std::vector<wxString> variantsToRemove;
|
|
|
|
for( const wxString& existingName : m_board->GetVariantNames() )
|
|
{
|
|
bool found = false;
|
|
|
|
for( const wxString& variantName : netlistVariants )
|
|
{
|
|
if( existingName.CmpNoCase( variantName ) == 0 )
|
|
{
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( !found )
|
|
variantsToRemove.push_back( existingName );
|
|
}
|
|
|
|
for( const wxString& variantName : variantsToRemove )
|
|
{
|
|
m_board->DeleteVariant( variantName );
|
|
msg.Printf( _( "Removed variant '%s'." ), variantName );
|
|
m_reporter->Report( msg, RPT_SEVERITY_ACTION );
|
|
}
|
|
|
|
if( !updatedVariantNames.empty() )
|
|
m_board->SetVariantNames( updatedVariantNames );
|
|
}
|
|
|
|
// When new footprints are added, the automatic zone refill is disabled because:
|
|
// * it creates crashes when calculating dynamic ratsnests if auto refill is enabled.
|
|
// (the auto refills rebuild the connectivity with incomplete data)
|
|
// * it is useless because zones will be refilled after placing new footprints
|
|
m_commit.Push( _( "Update Netlist" ), m_newFootprintsCount ? ZONE_FILL_OP : 0 );
|
|
|
|
// Update net, netcode and netclass data after commiting the netlist
|
|
m_board->SynchronizeNetsAndNetClasses( true );
|
|
m_board->GetConnectivity()->RefreshNetcodeMap( m_board );
|
|
|
|
// Although m_commit will probably also set this, it's not guaranteed, and we need to make
|
|
// sure any modification to netclasses gets persisted to project settings through a save.
|
|
if( m_frame )
|
|
m_frame->OnModify();
|
|
}
|
|
|
|
if( m_isDryRun )
|
|
{
|
|
for( const std::pair<const wxString, NETINFO_ITEM*>& addedNet : m_addedNets )
|
|
delete addedNet.second;
|
|
|
|
m_addedNets.clear();
|
|
}
|
|
|
|
// Update the ratsnest
|
|
m_reporter->ReportTail( wxT( "" ), RPT_SEVERITY_ACTION );
|
|
m_reporter->ReportTail( wxT( "" ), RPT_SEVERITY_ACTION );
|
|
|
|
msg.Printf( _( "Total warnings: %d, errors: %d." ), m_warningCount, m_errorCount );
|
|
m_reporter->ReportTail( msg, RPT_SEVERITY_INFO );
|
|
|
|
return true;
|
|
}
|