netinfo_list.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#include "netinfo.h"
 
#include <wx/log.h>
 
#include <board.h>
#include <board_commit.h>
#include <footprint.h>
#include <macros.h>
#include <pad.h>
#include <pcb_shape.h>
#include <pcb_track.h>
#include <reporter.h>
#include <string_utils.h>
#include <trace_helpers.h>
#include <zone.h>
#include <unordered_map>
 
 
// Constructor and destructor
NETINFO_LIST::NETINFO_LIST( BOARD* aParent ) :
    m_parent( aParent ),
    m_newNetCode( 0 )
{
    // Make sure that the unconnected net has number 0
    AppendNet( new NETINFO_ITEM( aParent, wxEmptyString, 0 ) );
}
 
 
NETINFO_LIST::~NETINFO_LIST()
{
    clear();
}
 
 
void NETINFO_LIST::clear()
{
    NETNAMES_MAP::iterator it, itEnd;
 
    for( it = m_netNames.begin(), itEnd = m_netNames.end(); it != itEnd; ++it )
        delete it->second;
 
    detachAll();
}
 
 
void NETINFO_LIST::detachAll()
{
    m_netNames.clear();
    m_netCodes.clear();
    m_newNetCode = 0;
}
 
 
NETINFO_ITEM* NETINFO_LIST::GetNetItem( int aNetCode ) const
{
    NETCODES_MAP::const_iterator result = m_netCodes.find( aNetCode );
 
    if( result != m_netCodes.end() )
        return (*result).second;
 
    return nullptr;
}
 
 
NETINFO_ITEM* NETINFO_LIST::GetNetItem( const wxString& aNetName ) const
{
    NETNAMES_MAP::const_iterator result = m_netNames.find( aNetName );
 
    if( result != m_netNames.end() )
        return (*result).second;
 
    return nullptr;
}
 
 
void NETINFO_LIST::RemoveNet( NETINFO_ITEM* aNet )
{
    bool removed = false;
 
    for( NETCODES_MAP::iterator i = m_netCodes.begin(); i != m_netCodes.end(); ++i )
    {
        if ( i->second == aNet )
        {
            removed = true;
            m_netCodes.erase(i);
            break;
        }
    }
 
    for( NETNAMES_MAP::iterator i = m_netNames.begin(); i != m_netNames.end(); ++i )
    {
        if ( i->second == aNet )
        {
            wxASSERT_MSG( removed, wxT( "NETINFO_LIST::RemoveNet: target net found in m_netNames "
                                        "but not m_netCodes!" ) );
            m_netNames.erase(i);
            break;
        }
    }
 
    if( removed )
    {
        m_newNetCode = std::min( m_newNetCode, aNet->m_netCode - 1 );
        m_DisplayNetnamesDirty = true;
    }
}
 
 
void NETINFO_LIST::RemoveUnusedNets( BOARD_COMMIT* aCommit )
{
    NETCODES_MAP               existingNets = m_netCodes;
    std::vector<NETINFO_ITEM*> unusedNets;
 
    m_netCodes.clear();
    m_netNames.clear();
 
    for( const auto& [ netCode, netInfo ] : existingNets )
    {
        if( netInfo->IsCurrent() )
        {
            m_netNames.insert( std::make_pair( netInfo->GetNetname(), netInfo ) );
            m_netCodes.insert( std::make_pair( netCode, netInfo ) );
        }
        else
        {
            m_DisplayNetnamesDirty = true;
 
            if( aCommit )
                aCommit->Removed( netInfo );
        }
    }
}
 
 
void NETINFO_LIST::AppendNet( NETINFO_ITEM* aNewElement )
{
    // if there is a net with such name then just assign the correct number
    NETINFO_ITEM* sameName = GetNetItem( aNewElement->GetNetname() );
 
    if( sameName != nullptr )
    {
        aNewElement->m_netCode = sameName->GetNetCode();
 
        return;
    }
    else if( aNewElement->m_netCode != (int) m_netCodes.size() || aNewElement->m_netCode < 0 )
    {
        // be sure that net codes are consecutive
        // negative net code means that it has to be auto assigned
        aNewElement->m_netCode = getFreeNetCode();
    }
 
    // net names & codes are supposed to be unique
    assert( GetNetItem( aNewElement->GetNetname() ) == nullptr );
    assert( GetNetItem( aNewElement->GetNetCode() ) == nullptr );
 
    // add an entry for fast look up by a net name using a map
    m_netNames.insert( std::make_pair( aNewElement->GetNetname(), aNewElement ) );
    m_netCodes.insert( std::make_pair( aNewElement->GetNetCode(), aNewElement ) );
 
    m_DisplayNetnamesDirty = true;
}
 
 
void NETINFO_LIST::buildListOfNets()
{
    // Preserve any parsed net-chain names and terminal pad UUIDs before clearing. The GUI load
    // path calls BuildListOfNets() after the board file is parsed (see files.cpp) which was
    // unintentionally wiping the m_netChain field set by the (net_chains ...) section.  Cache and
    // restore them so persisted chains survive the rebuild.
    std::unordered_map<int, wxString> preservedNetChains;
    std::unordered_map<int, KIID>     preservedPad0;
    std::unordered_map<int, KIID>     preservedPad1;
 
    preservedNetChains.reserve( GetNetCount() );
    preservedPad0.reserve( GetNetCount() );
    preservedPad1.reserve( GetNetCount() );
 
    for( NETINFO_ITEM* net : *this )
    {
        preservedNetChains[ net->GetNetCode() ] = net->GetNetChain();
        preservedPad0[ net->GetNetCode() ]    = net->GetTerminalPadUuid( 0 );
        preservedPad1[ net->GetNetCode() ]    = net->GetTerminalPadUuid( 1 );
    }
 
    // Restore the initial state of NETINFO_ITEMs (except chains & terminal pad UUIDs which we reapply)
    for( NETINFO_ITEM* net : *this )
        net->Clear();
 
    for( NETINFO_ITEM* net : *this )
    {
        auto it = preservedNetChains.find( net->GetNetCode() );
        if( it != preservedNetChains.end() )
            net->SetNetChain( it->second );
 
        auto ip0 = preservedPad0.find( net->GetNetCode() );
        if( ip0 != preservedPad0.end() )
            net->SetTerminalPadUuid( 0, ip0->second );
 
        auto ip1 = preservedPad1.find( net->GetNetCode() );
        if( ip1 != preservedPad1.end() )
            net->SetTerminalPadUuid( 1, ip1->second );
    }
 
    m_parent->SynchronizeNetsAndNetClasses( false );
    m_parent->SetAreasNetCodesFromNetNames();
}
 
 
void NETINFO_LIST::RebuildDisplayNetnames() const
{
    std::map<wxString, std::vector<wxString>> shortNameMap;
 
    for( NETINFO_ITEM* net : *this )
        shortNameMap[net->m_shortNetname].push_back( net->m_netname );
 
    for( NETINFO_ITEM* net : *this )
    {
        if( shortNameMap[net->m_shortNetname].size() == 1 )
        {
            net->m_displayNetname = UnescapeString( net->m_shortNetname );
        }
        else
        {
            wxArrayString              parts = wxSplit( net->m_netname, '/' );
            std::vector<wxArrayString> aggregateParts;
            std::optional<size_t>      firstNonCommon;
 
            for( const wxString& longName : shortNameMap[net->m_shortNetname] )
                aggregateParts.push_back( wxSplit( longName, '/' ) );
 
            for( size_t ii = 0; ii < parts.size() && !firstNonCommon; ++ii )
            {
                for( const wxArrayString& otherParts : aggregateParts )
                {
                    if( ii < otherParts.size() && otherParts[ii] == parts[ii] )
                        continue;
 
                    firstNonCommon = ii;
                    break;
                }
            }
 
            if( firstNonCommon.value_or( 0 ) > 0 && firstNonCommon.value() < parts.size() )
            {
                wxString disambiguatedName;
 
                for( size_t ii = firstNonCommon.value(); ii < parts.size(); ++ii )
                {
                    if( !disambiguatedName.IsEmpty() )
                        disambiguatedName += wxS( "/" );
 
                    disambiguatedName += parts[ii];
                }
 
                net->m_displayNetname = UnescapeString( disambiguatedName );
            }
            else
            {
                net->m_displayNetname = UnescapeString( net->m_netname );
            }
        }
    }
 
    m_DisplayNetnamesDirty = false;
}
 
 
#if defined(DEBUG)
void NETINFO_LIST::Show() const
{
    int i = 0;
    NETNAMES_MAP::const_iterator it, itEnd;
 
    for( it = m_netNames.begin(), itEnd = m_netNames.end(); it != itEnd; ++it )
    {
        wxLogDebug( wxT( "[%d]: netcode:%d  netname:<%s>\n" ),
                    i++,
                    it->second->GetNetCode(),
                    TO_UTF8( it->second->GetNetname() ) );
    }
}
#endif
 
 
int NETINFO_LIST::getFreeNetCode()
{
    do
    {
        if( m_newNetCode < 0 )
            m_newNetCode = 0;
    } while( m_netCodes.count( ++m_newNetCode ) != 0 );
 
    return m_newNetCode;
}
 
 
bool NETINFO_LIST::RenameNets( const std::map<wxString, wxString>& aNewNames, REPORTER& aReporter )
{
    if( aNewNames.empty() )
        return true;
 
    // Validate against a copy so a rejected batch leaves the live lookup untouched.
    NETNAMES_MAP                                   finalNames = m_netNames;
    std::vector<std::pair<NETINFO_ITEM*, wxString>> renames;
    size_t                                         missing = 0;
 
    for( const auto& [source, target] : aNewNames )
    {
        NETINFO_ITEM* net = GetNetItem( source );
 
        if( !net )
        {
            // A caller may legitimately offer names for nets this board does not have, but a run
            // where most names miss usually means the two sides qualify hierarchical names
            // differently.
            wxLogTrace( traceImportNetNames, wxS( "no net named '%s' to rename to '%s'" ), source,
                        target );
            ++missing;
            continue;
        }
 
        if( net->GetNetCode() <= 0 || target.IsEmpty() )
        {
            aReporter.Report( wxString::Format( _( "Cannot rename net '%s' to '%s': net zero and empty "
                                                   "names are reserved for unconnected items." ),
                                                source, target ), RPT_SEVERITY_ERROR );
            return false;
        }
 
        if( source == target )
            continue;
 
        renames.emplace_back( net, target );
        finalNames.erase( source );
    }
 
    wxLogTrace( traceImportNetNames, wxS( "renaming %zu of %zu nets, %zu not on this board" ),
                renames.size(), aNewNames.size(), missing );
 
    if( renames.empty() )
        return true;
 
    for( const auto& [net, target] : renames )
    {
        if( !finalNames.emplace( target, net ).second )
        {
            aReporter.Report( wxString::Format( _( "Cannot rename net '%s' to '%s': another net would "
                                                   "have the same name." ),
                                                net->GetNetname(), target ), RPT_SEVERITY_ERROR );
            return false;
        }
    }
 
    // Removing and re-adding nets would disconnect copper and can reassign net codes.
    for( const auto& [net, target] : renames )
        net->SetNetname( target );
 
    m_netNames.swap( finalNames );
    m_DisplayNetnamesDirty = true;
 
    return true;
}
 
 
const int NETINFO_LIST::UNCONNECTED = 0;
const int NETINFO_LIST::ORPHANED = -1;