kicad/pcbnew/board_connected_item.cpp

294 lines
12 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 1992-2022 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 <board.h>
#include <board_connected_item.h>
#include <board_design_settings.h>
#include <connectivity/connectivity_data.h>
#include <properties/property_validators.h>
#include <string_utils.h>
#include <i18n_utility.h>
#include <netinfo.h>
2020-02-05 10:54:25 +00:00
using namespace std::placeholders;
BOARD_CONNECTED_ITEM::BOARD_CONNECTED_ITEM( BOARD_ITEM* aParent, KICAD_T idtype ) :
BOARD_ITEM( aParent, idtype ),
m_netinfo( NETINFO_LIST::OrphanedItem() )
{
m_localRatsnestVisible = true;
}
bool BOARD_CONNECTED_ITEM::SetNetCode( int aNetCode, bool aNoAssert )
{
if( !IsOnCopperLayer() )
aNetCode = 0;
2021-03-01 10:16:40 +00:00
// if aNetCode < 0 (typically NETINFO_LIST::FORCE_ORPHANED) or no parent board,
// set the m_netinfo to the dummy NETINFO_LIST::ORPHANED
2014-01-14 09:41:52 +00:00
BOARD* board = GetBoard();
if( ( aNetCode >= 0 ) && board )
m_netinfo = board->FindNet( aNetCode );
Added NETINFO_MAPPING, to ease saving nets with consecutive net codes (without modifying the net codes during the run time). Now, nets are saved with consecutive net codes (both modern & legacy plugins). Zones are saved together with their nets, without depending on the fact if there are any pads with such net. Therefore validation of zone net names was removed (pcbnew/class_board.cpp). Performed tests: - Changed a pad's net name from empty to existent - ok, name was changed. - Changed a pad's net name from empty to nonexistent - ok, error message is displayed, net name stays empty. - Changed a pad's net name from existent to empty - ok, net name became empty - Changed a pad's net name from existent to nonexistent - ok, error message is displayed, net name is not changed. - Drawn a zone that belongs to a net, then modified schematics so the net does not exist anymore. After reloading the net list, all pads/tracks are updated. Zones still belongs to the net that does not exist in the schematic (but still exists in .kicad_pcb file). After running DRC, the zone becomes not filled. - Undo & redo affects assignment of a polygon to a specific net (you may change net of a polygon, refill it and undo/redo the changes). - KiCad s-expr & legacy, Eagle, P-CAD boards seem to load without any problem (they also contain correct net names assigned to the appropriate pads). All types of board file formats were loaded, then saved in sexpr format and reopened with a KiCad built from the master branch (without my modifications). - A few boards were also saved using the legacy format and were opened with the master KiCad without any issues. - Change a net name for a pad, restore with undo/redo - ok - Remove everything, restore with undo - ok - Remove everything, reload netlist - ok Differences observed between files saved by the master branch KiCad and this one: - list of nets are not saved in any particular order, so net codes may differ - the default net class does not contain the unconnected net
2014-01-28 09:19:51 +00:00
else
m_netinfo = NETINFO_LIST::OrphanedItem();
2014-11-27 10:47:17 +00:00
if( !aNoAssert )
wxASSERT( m_netinfo );
2021-07-19 23:56:05 +00:00
return ( m_netinfo != nullptr );
}
int BOARD_CONNECTED_ITEM::GetOwnClearance( PCB_LAYER_ID aLayer, wxString* aSource ) const
2009-08-17 02:59:38 +00:00
{
DRC_CONSTRAINT constraint;
if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
{
BOARD_DESIGN_SETTINGS& bds = GetBoard()->GetDesignSettings();
constraint = bds.m_DRCEngine->EvalRules( CLEARANCE_CONSTRAINT, this, nullptr, aLayer );
}
2009-08-17 02:59:38 +00:00
if( constraint.Value().HasMin() )
{
if( aSource )
*aSource = constraint.GetName();
2020-05-18 00:20:16 +00:00
return constraint.Value().Min();
}
2020-05-18 00:20:16 +00:00
return 0;
}
int BOARD_CONNECTED_ITEM::GetNetCode() const
{
return m_netinfo ? m_netinfo->GetNetCode() : -1;
}
2020-05-18 00:20:16 +00:00
// Note: do NOT return a std::shared_ptr from this. It is used heavily in DRC, and the
// std::shared_ptr stuff shows up large in performance profiling.
NETCLASS* BOARD_CONNECTED_ITEM::GetEffectiveNetClass() const
2009-08-17 02:59:38 +00:00
{
if( m_netinfo && m_netinfo->GetNetClass() )
return m_netinfo->GetNetClass();
else
return GetBoard()->GetDesignSettings().m_NetSettings->m_DefaultNetClass.get();
2009-08-17 02:59:38 +00:00
}
2014-01-14 09:41:52 +00:00
wxString BOARD_CONNECTED_ITEM::GetNetClassName() const
{
return GetEffectiveNetClass()->GetName();
}
wxString BOARD_CONNECTED_ITEM::GetNetname() const
{
return m_netinfo ? m_netinfo->GetNetname() : wxString();
}
wxString BOARD_CONNECTED_ITEM::GetNetnameMsg() const
{
if( !GetBoard() )
return wxT( "[** NO BOARD DEFINED **]" );
wxString netname = GetNetname();
if( !netname.length() )
return wxT( "[<no net>]" );
else if( GetNetCode() < 0 )
2022-02-04 22:44:59 +00:00
return wxT( "[" ) + UnescapeString( netname ) + wxT( "](" ) + _( "Not Found" ) + wxT( ")" );
else
2022-02-04 22:44:59 +00:00
return wxT( "[" ) + UnescapeString( netname ) + wxT( "]" );
}
wxString BOARD_CONNECTED_ITEM::GetShortNetname() const
{
return m_netinfo ? m_netinfo->GetShortNetname() : wxString();
}
wxString BOARD_CONNECTED_ITEM::GetUnescapedShortNetname() const
{
return m_netinfo ? m_netinfo->GetUnescapedShortNetname() : wxString();
}
static struct BOARD_CONNECTED_ITEM_DESC
{
BOARD_CONNECTED_ITEM_DESC()
{
ENUM_MAP<PCB_LAYER_ID>& layerEnum = ENUM_MAP<PCB_LAYER_ID>::Instance();
if( layerEnum.Choices().GetCount() == 0 )
{
layerEnum.Undefined( UNDEFINED_LAYER );
for( LSEQ seq = LSET::AllLayersMask().Seq(); seq; ++seq )
layerEnum.Map( *seq, LSET::Name( *seq ) );
}
PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
REGISTER_TYPE( BOARD_CONNECTED_ITEM );
propMgr.InheritsAfter( TYPE_HASH( BOARD_CONNECTED_ITEM ), TYPE_HASH( BOARD_ITEM ) );
2020-02-05 10:54:25 +00:00
// Replace layer property as the properties panel will set a restriction for copper layers
// only for BOARD_CONNECTED_ITEM that we don't want to apply to BOARD_ITEM
auto layer = new PROPERTY_ENUM<BOARD_CONNECTED_ITEM, PCB_LAYER_ID, BOARD_ITEM>(
_HKI( "Layer" ),
&BOARD_CONNECTED_ITEM::SetLayer, &BOARD_CONNECTED_ITEM::GetLayer );
layer->SetChoices( layerEnum.Choices() );
propMgr.ReplaceProperty( TYPE_HASH( BOARD_ITEM ), _HKI( "Layer" ), layer );
propMgr.AddProperty( new PROPERTY_ENUM<BOARD_CONNECTED_ITEM, int>( _HKI( "Net" ),
&BOARD_CONNECTED_ITEM::SetNetCode,
&BOARD_CONNECTED_ITEM::GetNetCode ) )
.SetIsHiddenFromRulesEditor()
.SetIsHiddenFromLibraryEditors();
/**
* This property should just be an alias for the one below, it only exists so that we
* maintain compatibility with both `NetClass` and `Net_Class` in custom rules.
* It has the name we would show in the GUI if we wanted to show this in the GUI, but we
* don't at the moment because there is no way to edit the netclass of a net from a selected
* connected item, and showing it makes users think they can change it.
*/
propMgr.AddProperty( new PROPERTY<BOARD_CONNECTED_ITEM, wxString>( _HKI( "Net Class" ),
NO_SETTER( BOARD_CONNECTED_ITEM, wxString ),
&BOARD_CONNECTED_ITEM::GetNetClassName ) )
.SetIsHiddenFromRulesEditor()
.SetIsHiddenFromPropertiesManager()
.SetIsHiddenFromLibraryEditors();
// Compatibility alias for DRC engine
propMgr.AddProperty( new PROPERTY<BOARD_CONNECTED_ITEM, wxString>( _HKI( "NetClass" ),
NO_SETTER( BOARD_CONNECTED_ITEM, wxString ),
&BOARD_CONNECTED_ITEM::GetNetClassName ) )
.SetIsHiddenFromPropertiesManager()
.SetIsHiddenFromLibraryEditors();
// Used only in DRC engine
propMgr.AddProperty( new PROPERTY<BOARD_CONNECTED_ITEM, wxString>( _HKI( "NetName" ),
NO_SETTER( BOARD_CONNECTED_ITEM, wxString ),
&BOARD_CONNECTED_ITEM::GetNetname ) )
.SetIsHiddenFromPropertiesManager()
.SetIsHiddenFromLibraryEditors();
auto supportsTeardrops =
[]( INSPECTABLE* aItem ) -> bool
{
if( BOARD_CONNECTED_ITEM* bci = dynamic_cast<BOARD_CONNECTED_ITEM*>( aItem ) )
{
if( bci->GetBoard()->LegacyTeardrops() )
return false;
return bci->Type() == PCB_PAD_T || bci->Type() == PCB_VIA_T;
}
return false;
};
auto supportsTeardropPreferZoneSetting =
[]( INSPECTABLE* aItem ) -> bool
{
if( BOARD_CONNECTED_ITEM* bci = dynamic_cast<BOARD_CONNECTED_ITEM*>( aItem ) )
{
if( bci->GetBoard()->LegacyTeardrops() )
return false;
return bci->Type() == PCB_PAD_T;
}
return false;
};
const wxString groupTeardrops = _HKI( "Teardrops" );
auto enableTeardrops = new PROPERTY<BOARD_CONNECTED_ITEM, bool>( _HKI( "Enable Teardrops" ),
&BOARD_CONNECTED_ITEM::SetTeardropsEnabled,
&BOARD_CONNECTED_ITEM::GetTeardropsEnabled );
enableTeardrops->SetAvailableFunc( supportsTeardrops );
propMgr.AddProperty( enableTeardrops, groupTeardrops );
auto bestLength = new PROPERTY<BOARD_CONNECTED_ITEM, double>( _HKI( "Best Length Ratio" ),
&BOARD_CONNECTED_ITEM::SetTeardropBestLengthRatio,
&BOARD_CONNECTED_ITEM::GetTeardropBestLengthRatio );
bestLength->SetAvailableFunc( supportsTeardrops );
bestLength->SetValidator( PROPERTY_VALIDATORS::PositiveRatioValidator );
propMgr.AddProperty( bestLength, groupTeardrops );
auto maxLength = new PROPERTY<BOARD_CONNECTED_ITEM, int>( _HKI( "Max Length" ),
&BOARD_CONNECTED_ITEM::SetTeardropMaxLength,
&BOARD_CONNECTED_ITEM::GetTeardropMaxLength, PROPERTY_DISPLAY::PT_SIZE );
maxLength->SetAvailableFunc( supportsTeardrops );
propMgr.AddProperty( maxLength, groupTeardrops );
auto bestWidth = new PROPERTY<BOARD_CONNECTED_ITEM, double>( _HKI( "Best Width Ratio" ),
&BOARD_CONNECTED_ITEM::SetTeardropBestWidthRatio,
&BOARD_CONNECTED_ITEM::GetTeardropBestWidthRatio );
bestWidth->SetAvailableFunc( supportsTeardrops );
bestWidth->SetValidator( PROPERTY_VALIDATORS::PositiveRatioValidator );
propMgr.AddProperty( bestWidth, groupTeardrops );
auto maxWidth = new PROPERTY<BOARD_CONNECTED_ITEM, int>( _HKI( "Max Width" ),
&BOARD_CONNECTED_ITEM::SetTeardropMaxWidth,
&BOARD_CONNECTED_ITEM::GetTeardropMaxWidth, PROPERTY_DISPLAY::PT_SIZE );
maxWidth->SetAvailableFunc( supportsTeardrops );
propMgr.AddProperty( maxWidth, groupTeardrops );
auto curvePts = new PROPERTY<BOARD_CONNECTED_ITEM, int>( _HKI( "Curve Points" ),
&BOARD_CONNECTED_ITEM::SetTeardropCurvePts,
&BOARD_CONNECTED_ITEM::GetTeardropCurvePts );
curvePts->SetAvailableFunc( supportsTeardrops );
propMgr.AddProperty( curvePts, groupTeardrops );
2023-11-23 20:32:29 +00:00
auto preferZones = new PROPERTY<BOARD_CONNECTED_ITEM, bool>( _HKI( "Prefer Zone Connections" ),
&BOARD_CONNECTED_ITEM::SetTeardropPreferZoneConnections,
&BOARD_CONNECTED_ITEM::GetTeardropPreferZoneConnections );
preferZones->SetAvailableFunc( supportsTeardropPreferZoneSetting );
propMgr.AddProperty( preferZones, groupTeardrops );
2023-11-23 20:32:29 +00:00
auto twoTracks = new PROPERTY<BOARD_CONNECTED_ITEM, bool>( _HKI( "Allow Teardrops To Span Two Tracks" ),
&BOARD_CONNECTED_ITEM::SetTeardropAllowSpanTwoTracks,
&BOARD_CONNECTED_ITEM::GetTeardropAllowSpanTwoTracks );
twoTracks->SetAvailableFunc( supportsTeardrops );
propMgr.AddProperty( twoTracks, groupTeardrops );
auto maxTrackWidth = new PROPERTY<BOARD_CONNECTED_ITEM, double>( _HKI( "Max Width Ratio" ),
&BOARD_CONNECTED_ITEM::SetTeardropMaxTrackWidth,
&BOARD_CONNECTED_ITEM::GetTeardropMaxTrackWidth );
maxTrackWidth->SetAvailableFunc( supportsTeardrops );
propMgr.AddProperty( maxTrackWidth, groupTeardrops );
}
} _BOARD_CONNECTED_ITEM_DESC;