pcb_netlist.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2011 Jean-Pierre Charras.
 * Copyright (C) 2013 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, see <https://www.gnu.org/licenses/>.
 */
 
#include "pcb_netlist.h"
 
#include <wx/tokenzr.h>
#include <wx/log.h>
 
#include <footprint.h>
#include <richio.h>
#include <string_utils.h>
 
#include <algorithm>
 
 
int COMPONENT_NET::Format( OUTPUTFORMATTER* aOut, int aNestLevel, int aCtl )
{
    return aOut->Print( aNestLevel, "(pin_net %s %s)",
                        aOut->Quotew( m_pinName ).c_str(),
                        aOut->Quotew( m_netName ).c_str() );
}
 
COMPONENT::COMPONENT( const LIB_ID&            aFPID,
                      const wxString&          aReference,
                      const wxString&          aValue,
                      const KIID_PATH&         aPath,
                      const std::vector<KIID>& aKiids )
{
    m_fpid             = aFPID;
    m_reference        = aReference;
    m_value            = aValue;
    m_pinCount         = 0;
    m_path             = aPath;
    m_kiids            = aKiids;
    m_duplicatePadNumbersAreJumpers = false;
    m_group            = nullptr;
}
 
 
COMPONENT::~COMPONENT()
{
}
 
 
FOOTPRINT* COMPONENT::GetFootprint( bool aRelease )
{
    return ( aRelease ) ? m_footprint.release() : m_footprint.get();
}
 
 
void COMPONENT::SetFootprint( FOOTPRINT* aFootprint )
{
    m_footprint.reset( aFootprint );
    KIID_PATH path = m_path;
 
    if( !m_kiids.empty() )
        path.push_back( m_kiids.front() );
 
    if( aFootprint == nullptr )
        return;
 
    aFootprint->SetReference( m_reference );
    aFootprint->SetValue( m_value );
    aFootprint->SetFPID( m_fpid );
    aFootprint->SetPath( path );
 
    // Copy over unit info
    std::vector<FOOTPRINT::FP_UNIT_INFO> fpUnits;
 
    for( const UNIT_INFO& u : m_units )
        fpUnits.push_back( { u.m_unitName, u.m_pins } );
 
    aFootprint->SetUnitInfo( fpUnits );
}
 
 
COMPONENT_NET COMPONENT::m_emptyNet;
 
 
 
 
const COMPONENT_NET& COMPONENT::GetNet( const wxString& aPinName ) const
{
    const COMPONENT_NET* fallback = nullptr;
 
    for( const COMPONENT_NET& net : m_nets )
    {
        if( net.GetPinName() != aPinName )
        {
            if( !net.GetPinName().StartsWith( wxS( "[" ) ) )
                continue;
 
            const std::vector<wxString> expanded = ExpandStackedPinNotation( net.GetPinName() );
 
            if( std::find( expanded.begin(), expanded.end(), aPinName ) == expanded.end() )
                continue;
        }
 
        if( !fallback )
            fallback = &net;
 
        // Shared-unit pins can export both an explicit net and automatic unconnected nets.
        if( !net.GetNetName().IsEmpty() && !IsAutoGeneratedNetName( net.GetNetName() ) )
            return net;
    }
 
    return fallback ? *fallback : m_emptyNet;
}
 
 
const COMPONENT_VARIANT* COMPONENT::GetVariant( const wxString& aVariantName ) const
{
    auto it = m_variants.find( aVariantName );
 
    return it != m_variants.end() ? &it->second : nullptr;
}
 
 
COMPONENT_VARIANT* COMPONENT::GetVariant( const wxString& aVariantName )
{
    auto it = m_variants.find( aVariantName );
 
    return it != m_variants.end() ? &it->second : nullptr;
}
 
 
void COMPONENT::AddVariant( const COMPONENT_VARIANT& aVariant )
{
    if( aVariant.m_name.IsEmpty() )
        return;
 
    auto it = m_variants.find( aVariant.m_name );
 
    if( it != m_variants.end() )
    {
        COMPONENT_VARIANT updated = aVariant;
        updated.m_name = it->first;
        it->second = std::move( updated );
        return;
    }
 
    m_variants.emplace( aVariant.m_name, aVariant );
}
 
 
void COMPONENT::Format( OUTPUTFORMATTER* aOut, int aNestLevel, int aCtl )
{
    int nl = aNestLevel;
 
    aOut->Print( nl, "(ref %s ",      aOut->Quotew( m_reference ).c_str() );
    aOut->Print( 0, "(fpid %s)\n",    aOut->Quotew( m_fpid.Format() ).c_str() );
 
    if( !( aCtl & CTL_OMIT_EXTRA ) )
    {
        aOut->Print( nl+1, "(value %s)\n",    aOut->Quotew( m_value ).c_str() );
        aOut->Print( nl+1, "(name %s)\n",     aOut->Quotew( m_name ).c_str() );
        aOut->Print( nl+1, "(library %s)\n",  aOut->Quotew( m_library ).c_str() );
 
        wxString path;
 
        for( const KIID& pathStep : m_path )
            path += '/' + pathStep.AsString();
 
        if( !( aCtl & CTL_OMIT_FP_UUID ) && !m_kiids.empty() )
            path += '/' + m_kiids.front().AsString();
 
        aOut->Print( nl+1, "(timestamp %s)\n", aOut->Quotew( path ).c_str() );
 
        // Add all fields as a (field) under a (fields) node
        aOut->Print( nl + 1, "(fields" );
 
        for( std::pair<wxString, wxString> field : m_fields )
            aOut->Print( nl + 2, "\n(field (name %s) %s)", aOut->Quotew( field.first ).c_str(),
                         aOut->Quotew( field.second ).c_str() );
 
        aOut->Print( 0, ")\n" );
 
        // Add DNP and exclusion properties if we have them
        if( m_properties.count( "dnp" ) )
            aOut->Print( nl + 1, "(property (name \"dnp\"))\n" );
 
        if( m_properties.count( "exclude_from_bom" ) )
            aOut->Print( nl + 1, "(property (name \"exclude_from_bom\"))\n" );
 
        if( m_properties.count( "exclude_from_sim" ) )
            aOut->Print( nl + 1, "(property (name \"exclude_from_sim\"))\n" );
 
        if( m_properties.count( "exclude_from_pos_files" ) )
            aOut->Print( nl + 1, "(property (name \"exclude_from_pos_files\"))\n" );
 
        if( !m_variants.empty() )
        {
            aOut->Print( nl + 1, "(variants" );
 
            for( const auto& [variantName, variant] : m_variants )
            {
                aOut->Print( nl + 2, "\n(variant (name %s)",
                             aOut->Quotew( variantName ).c_str() );
 
                if( variant.m_hasDnp )
                {
                    aOut->Print( 0, " (property (name \"dnp\") (value %s))",
                                 aOut->Quotew( variant.m_dnp ? wxT( "1" ) : wxT( "0" ) ).c_str() );
                }
 
                if( variant.m_hasExcludedFromBOM )
                {
                    aOut->Print( 0, " (property (name \"exclude_from_bom\") (value %s))",
                                 aOut->Quotew( variant.m_excludedFromBOM ? wxT( "1" ) : wxT( "0" ) ).c_str() );
                }
 
                if( variant.m_hasExcludedFromSim )
                {
                    aOut->Print( 0, " (property (name \"exclude_from_sim\") (value %s))",
                                 aOut->Quotew( variant.m_excludedFromSim ? wxT( "1" ) : wxT( "0" ) ).c_str() );
                }
 
                if( variant.m_hasExcludedFromPosFiles )
                {
                    aOut->Print( 0, " (property (name \"exclude_from_pos_files\") (value %s))",
                                 aOut->Quotew( variant.m_excludedFromPosFiles ? wxT( "1" ) : wxT( "0" ) ).c_str() );
                }
 
                if( !variant.m_fields.empty() )
                {
                    aOut->Print( 0, "\n" );
                    aOut->Print( nl + 3, "(fields" );
 
                    for( const auto& [fieldName, fieldValue] : variant.m_fields )
                    {
                        aOut->Print( nl + 4, "\n(field (name %s) %s)",
                                     aOut->Quotew( fieldName ).c_str(),
                                     aOut->Quotew( fieldValue ).c_str() );
                    }
 
                    aOut->Print( 0, ")" );
                }
 
                aOut->Print( 0, ")" );
            }
 
            aOut->Print( 0, ")\n" );
        }
    }
 
    if( !( aCtl & CTL_OMIT_FILTERS ) && m_footprintFilters.GetCount() )
    {
        aOut->Print( nl+1, "(fp_filters" );
 
        for( unsigned i = 0;  i < m_footprintFilters.GetCount();  ++i )
            aOut->Print( 0, " %s", aOut->Quotew( m_footprintFilters[i] ).c_str() );
 
        aOut->Print( 0, ")\n" );
    }
 
    if( !( aCtl & CTL_OMIT_NETS ) && m_nets.size() )
    {
        int llen = aOut->Print( nl+1, "(nets " );
 
        for( unsigned i = 0;  i < m_nets.size();  ++i )
        {
            if( llen > 80 )
            {
                aOut->Print( 0, "\n" );
                llen = aOut->Print( nl+1, "  " );
            }
 
            llen += m_nets[i].Format( aOut, 0, aCtl );
        }
 
        aOut->Print( 0, ")\n" );
    }
 
    aOut->Print( nl, ")\n" );    // </ref>
}
 
 
void NETLIST::Format( const char* aDocName, OUTPUTFORMATTER* aOut, int aNestLevel, int aCtl )
{
    int nl = aNestLevel;
 
    aOut->Print( nl, "(%s\n", aDocName );
 
    for( unsigned i = 0;  i < m_components.size();  i++ )
    {
        m_components[i].Format( aOut, nl+1, aCtl );
    }
 
    aOut->Print( nl, ")\n" );
}
 
 
void NETLIST::AddComponent( COMPONENT* aComponent )
{
    m_components.push_back( aComponent );
}
 
 
void NETLIST::AddGroup( NETLIST_GROUP* aComponent )
{
    m_groups.push_back( aComponent );
}
 
NETLIST_GROUP* NETLIST::GetGroupByUuid( const KIID& aUuid )
{
    for( NETLIST_GROUP& group : m_groups )
    {
        if( group.uuid == aUuid )
            return &group;
    }
 
    return nullptr;
}
 
 
COMPONENT* NETLIST::GetComponentByReference( const wxString& aReference )
{
    COMPONENT* component = nullptr;
 
    for( unsigned i = 0;  i < m_components.size();  i++ )
    {
        if( m_components[i].GetReference() == aReference )
        {
            component = &m_components[i];
            break;
        }
    }
 
    return component;
}
 
 
COMPONENT* NETLIST::GetComponentByPath( const KIID_PATH& aUuidPath )
{
    if( aUuidPath.empty() )
        return nullptr;
 
    KIID comp_uuid = aUuidPath.back();
    KIID_PATH base = aUuidPath;
 
    if( !base.empty() )
        base.pop_back();
 
    for( COMPONENT& component : m_components )
    {
        const std::vector<KIID>& kiids = component.GetKIIDs();
 
        if( base != component.GetPath() )
            continue;
 
        if( std::find( kiids.begin(), kiids.end(), comp_uuid ) != kiids.end() )
            return &component;
    }
 
    return nullptr;
}
 
 
COMPONENT* NETLIST::GetComponentByUuid( const KIID& aUuid)
{
    if( aUuid == 0 )
        return nullptr;
 
    for( COMPONENT& component : m_components )
    {
        for( const KIID& compUuid : component.GetKIIDs() )
        {
            if( aUuid == compUuid )
                return &component;
        }
    }
 
    return nullptr;
}
 

static bool ByFPID( const COMPONENT& ref, const COMPONENT& cmp )
{
    return ref.GetFPID() > cmp.GetFPID();
}
 
 
void NETLIST::SortByFPID()
{
    m_components.sort( ByFPID );
}
 

bool operator < ( const COMPONENT& item1, const COMPONENT& item2 )
{
    return StrNumCmp( item1.GetReference(), item2.GetReference(), true ) < 0;
}
 
 
void NETLIST::SortByReference()
{
    m_components.sort();
}
 
 
bool NETLIST::AnyFootprintsLinked() const
{
    for( unsigned i = 0;  i < m_components.size();  i++ )
    {
        if( !m_components[i].GetFPID().empty() )
            return true;
    }
 
    return false;
}
 
 
void NETLIST::ApplyGroupMembership()
{
    for( NETLIST_GROUP& group : m_groups )
    {
        for( const KIID_PATH& member : group.members )
        {
            COMPONENT* component = nullptr;
 
            if( member.size() > 1 )
            {
                // Instance path, match the exact instance. The same symbol uuid exists once
                // per instance of a shared sheet, only the path tells them apart.
                component = GetComponentByPath( member );
            }
            else if( member.size() == 1 )
            {
                // Bare symbol uuid
                component = GetComponentByUuid( member.front() );
            }
 
            if( component )
                component->SetGroup( &group );
        }
    }
}