pcb_netlist.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 Jean-Pierre Charras.
 * Copyright (C) 2013-2016 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/>.
 */
 
#ifndef PCB_NETLIST_H
#define PCB_NETLIST_H
 
#include <boost/ptr_container/ptr_vector.hpp>
#include <wx/arrstr.h>
#include <json_common.h>
#include <unordered_set>
#include <set>
#include <map>
 
#include <kiid.h>
#include <lib_id.h>
#include <ctl_flags.h>
#include <case_insensitive_map.h>
#include <jumper_group.h>
 
 
class REPORTER;
class FOOTPRINT;
class OUTPUTFORMATTER;
 

class COMPONENT_NET
{
public:
    COMPONENT_NET() {}
 
    COMPONENT_NET( const wxString& aPinName, const wxString& aNetName,
                   const wxString& aPinFunction, const wxString& aPinType ) :
        m_pinName( aPinName ),
        m_netName( aNetName ),
        m_pinFunction( aPinFunction ),
        m_pinType( aPinType )
    {
    }
 
    const wxString& GetPinName() const { return m_pinName; }
    const wxString& GetNetName() const { return m_netName; }
    const wxString& GetPinFunction() const { return m_pinFunction; }
    const wxString& GetPinType() const { return m_pinType; }
 
    bool IsValid() const { return !m_pinName.IsEmpty(); }
 
    bool operator <( const COMPONENT_NET& aNet ) const
    {
        return m_pinName < aNet.m_pinName;
    }
 
    int Format( OUTPUTFORMATTER* aOut, int aNestLevel, int aCtl );
 
private:
    wxString m_pinName;
    wxString m_netName;
    wxString m_pinFunction;
    wxString m_pinType;
};
 
 
typedef std::vector< COMPONENT_NET > COMPONENT_NETS;
 
 
struct NETLIST_GROUP
{
    wxString name;
    KIID uuid;
    LIB_ID            libId;
 
    // Full instance paths of the member symbols (sheet path + symbol uuid)
    std::vector<KIID_PATH> members;
};
 
 
struct COMPONENT_VARIANT
{
    COMPONENT_VARIANT( const wxString& aName = wxEmptyString ) : m_name( aName ) {}
 
    wxString m_name;
    bool     m_dnp = false;
    bool     m_excludedFromBOM = false;
    bool     m_excludedFromSim = false;
    bool     m_excludedFromPosFiles = false;
 
    bool     m_hasDnp = false;
    bool     m_hasExcludedFromBOM = false;
    bool     m_hasExcludedFromSim = false;
    bool     m_hasExcludedFromPosFiles = false;
 
    nlohmann::ordered_map<wxString, wxString> m_fields;
};
 

class COMPONENT
{
public:
    COMPONENT( const LIB_ID&            aFPID,
               const wxString&          aReference,
               const wxString&          aValue,
               const KIID_PATH&         aPath,
               const std::vector<KIID>& aKiids );
 
    virtual ~COMPONENT();
 
    void AddNet( const wxString& aPinName, const wxString& aNetName, const wxString& aPinFunction,
                 const wxString& aPinType )
    {
        m_nets.emplace_back( aPinName, aNetName, aPinFunction, aPinType );
    }
 
    unsigned GetNetCount() const { return m_nets.size(); }
 
    const COMPONENT_NET& GetNet( unsigned aIndex ) const { return m_nets[aIndex]; }
 
    const COMPONENT_NET& GetNet( const wxString& aPinName ) const;
 
    void ClearNets() { m_nets.clear(); }
 
    void SortPins() { sort( m_nets.begin(), m_nets.end() ); }
 
    void SetName( const wxString& aName ) { m_name = aName;}
    const wxString& GetName() const { return m_name; }
 
    void SetLibrary( const wxString& aLibrary ) { m_library = aLibrary; }
    const wxString& GetLibrary() const { return m_library; }
 
    void SetReference( const wxString& aReference ) { m_reference = aReference; }
    const wxString& GetReference() const { return m_reference; }
 
    void SetValue( const wxString& aValue ) { m_value = aValue; }
    const wxString& GetValue() const { return m_value; }
 
    void SetFields( nlohmann::ordered_map<wxString, wxString> aFields )
    {
        m_fields = std::move( aFields );
    }
    const nlohmann::ordered_map<wxString, wxString>& GetFields() const { return m_fields; }
 
    void SetProperties( std::map<wxString, wxString> aProps )
    {
        m_properties = std::move( aProps );
    }
    const std::map<wxString, wxString>& GetProperties() const { return m_properties; }
 
    void SetFPID( const LIB_ID& aFPID ) { m_fpid = aFPID;  }
    const LIB_ID& GetFPID() const { return m_fpid; }
 
    void SetAltFPID( const LIB_ID& aFPID ) { m_altFpid = aFPID; }
    const LIB_ID& GetAltFPID() const { return m_altFpid; }
 
    const KIID_PATH& GetPath() const { return m_path; }
 
    const std::vector<KIID>& GetKIIDs() const { return m_kiids; }
 
    void SetFootprintFilters( const wxArrayString& aFilters ) { m_footprintFilters = aFilters; }
    const wxArrayString& GetFootprintFilters() const { return m_footprintFilters; }
 
    void SetPinCount( int aPinCount ) { m_pinCount = aPinCount; }
    int GetPinCount() const { return m_pinCount; }
 
    FOOTPRINT* GetFootprint( bool aRelease = false );
 
    void SetFootprint( FOOTPRINT* aFootprint );
 
    bool IsLibSource( const wxString& aLibrary, const wxString& aName ) const
    {
        return aLibrary == m_library && aName == m_name;
    }
 
    void Format( OUTPUTFORMATTER* aOut, int aNestLevel, int aCtl );
 
    void SetHumanReadablePath( const wxString& aPath ) { m_humanReadablePath = aPath; }
    const wxString& GetHumanReadablePath() const { return m_humanReadablePath; }
 
    void SetComponentClassNames( const std::unordered_set<wxString>& aClassNames )
    {
        m_componentClassNames = aClassNames;
    }
 
    std::unordered_set<wxString>& GetComponentClassNames() { return m_componentClassNames; }
 
    bool GetDuplicatePadNumbersAreJumpers() const { return m_duplicatePadNumbersAreJumpers; }
    void SetDuplicatePadNumbersAreJumpers( bool aEnabled ) { m_duplicatePadNumbersAreJumpers = aEnabled; }
 
    JUMPER_GROUP_SET&       JumperPadGroups() { return m_jumperPadGroups; }
    const JUMPER_GROUP_SET& JumperPadGroups() const { return m_jumperPadGroups; }
 
    NETLIST_GROUP* GetGroup() const { return m_group; }
    void SetGroup( NETLIST_GROUP* aGroup ) { m_group = aGroup; }
 
    // Unit info for multi-unit symbols
    struct UNIT_INFO
    {
        wxString              m_unitName; // e.g. A
        std::vector<wxString> m_pins;     // pin numbers in this unit
    };
 
    void                          SetUnitInfo( const std::vector<UNIT_INFO>& aUnits ) { m_units = aUnits; }
    const std::vector<UNIT_INFO>& GetUnitInfo() const { return m_units; }
 
    const CASE_INSENSITIVE_MAP<COMPONENT_VARIANT>& GetVariants() const { return m_variants; }
    const COMPONENT_VARIANT* GetVariant( const wxString& aVariantName ) const;
    COMPONENT_VARIANT* GetVariant( const wxString& aVariantName );
    void AddVariant( const COMPONENT_VARIANT& aVariant );
 
private:
    std::vector<COMPONENT_NET>   m_nets;  
 
    wxArrayString                m_footprintFilters;
    int                          m_pinCount;
    wxString                     m_reference;
    wxString                     m_value;
 
    // human-readable hierarchical sheet path (e.g. /root/block0/sheet1)
    wxString                     m_humanReadablePath;

    KIID_PATH                    m_path;

    std::vector<KIID>            m_kiids;

    wxString                     m_name;

    wxString                     m_library;

    LIB_ID                       m_fpid;

    LIB_ID                       m_altFpid;

    std::unique_ptr<FOOTPRINT>   m_footprint;

    std::map<wxString, wxString> m_properties;

    nlohmann::ordered_map<wxString, wxString> m_fields;

    std::unordered_set<wxString> m_componentClassNames;

    JUMPER_GROUP_SET m_jumperPadGroups;

    bool m_duplicatePadNumbersAreJumpers;

    NETLIST_GROUP*               m_group;
 
    static COMPONENT_NET         m_emptyNet;
 
    // Unit information parsed from the netlist (optional)
    std::vector<UNIT_INFO> m_units;
 
    CASE_INSENSITIVE_MAP<COMPONENT_VARIANT> m_variants;
};
 

class NETLIST
{
public:
    NETLIST() :
        m_findByTimeStamp( false ),
        m_replaceFootprints( false )
    {
    }

    bool IsEmpty() const { return m_components.empty(); }

    void Clear()
    {
        m_components.clear();
        m_groups.clear();
        m_netSignals.clear();
        m_netChainTerminals.clear();
        m_netChainNetClasses.clear();
        m_netChainColors.clear();
        m_signalChainClasses.clear();
        m_variantNames.clear();
        m_variantDescriptions.clear();
    }

    unsigned GetCount() const { return m_components.size(); }

    COMPONENT* GetComponent( unsigned aIndex ) { return &m_components[ aIndex ]; }

    void AddComponent( COMPONENT* aComponent );

    void AddGroup( NETLIST_GROUP* aGroup );
 
    void SetNetChainFor( const wxString& aNet, const wxString& aNetChain )
    {
        m_netSignals[aNet] = aNetChain;
    }
 
    void AddSignalTerminalPin( const wxString& aNetChain, const wxString& aRef, const wxString& aPin )
    {
        m_netChainTerminals[aNetChain].emplace_back( aRef, aPin );
    }
 
    const std::vector<std::pair<wxString, wxString>>& GetNetChainTerminals( const wxString& aNetChain ) const
    {
        static const std::vector<std::pair<wxString, wxString>> empty;
        auto it = m_netChainTerminals.find( aNetChain );
        return it != m_netChainTerminals.end() ? it->second : empty;
    }
 
    const std::map<wxString, std::vector<std::pair<wxString, wxString>>>& GetNetChainTerminalPins() const
    {
        return m_netChainTerminals;
    }
 
    wxString GetNetChainFor( const wxString& aNet ) const
    {
        auto it = m_netSignals.find( aNet );
        return it != m_netSignals.end() ? it->second : wxString();
    }
 
    void SetSignalNetClass( const wxString& aNetChain, const wxString& aNetClass )
    {
        m_netChainNetClasses[aNetChain] = aNetClass;
    }
 
    wxString GetSignalNetClass( const wxString& aNetChain ) const
    {
        auto it = m_netChainNetClasses.find( aNetChain );
        return it != m_netChainNetClasses.end() ? it->second : wxString();
    }
 
    const std::map<wxString, wxString>& GetNetChainNetClasses() const
    {
        return m_netChainNetClasses;
    }

    void SetSignalColor( const wxString& aNetChain, const wxString& aColor )
    {
        m_netChainColors[aNetChain] = aColor;
    }
 
    wxString GetSignalColor( const wxString& aNetChain ) const
    {
        auto it = m_netChainColors.find( aNetChain );
        return it != m_netChainColors.end() ? it->second : wxString();
    }
 
    const std::map<wxString, wxString>& GetNetChainColors() const
    {
        return m_netChainColors;
    }

    void SetSignalChainClass( const wxString& aNetChain, const wxString& aClass )
    {
        m_signalChainClasses[aNetChain] = aClass;
    }
 
    wxString GetSignalChainClass( const wxString& aNetChain ) const
    {
        auto it = m_signalChainClasses.find( aNetChain );
        return it != m_signalChainClasses.end() ? it->second : wxString();
    }
 
    const std::map<wxString, wxString>& GetSignalChainClasses() const
    {
        return m_signalChainClasses;
    }

    NETLIST_GROUP* GetGroupByUuid( const KIID& aUuid );

    void ApplyGroupMembership();

    COMPONENT* GetComponentByReference( const wxString& aReference );

    COMPONENT* GetComponentByPath( const KIID_PATH& aPath );

    COMPONENT* GetComponentByUuid( const KIID& aUuid );
 
    void SortByFPID();
    void SortByReference();
 
    void SetFindByTimeStamp( bool aFindByTimeStamp ) { m_findByTimeStamp = aFindByTimeStamp; }
    bool IsFindByTimeStamp() const { return m_findByTimeStamp; }
 
    void SetReplaceFootprints( bool aReplace ) { m_replaceFootprints = aReplace; }
    bool GetReplaceFootprints() const { return m_replaceFootprints; }

    bool AnyFootprintsLinked() const;
 
    void Format( const char* aDocName, OUTPUTFORMATTER* aOut, int aNestLevel, int aCtl = 0 );
 
#define CTL_FOR_CVPCB    (CTL_OMIT_NETS | CTL_OMIT_FILTERS | CTL_OMIT_EXTRA)
 
    void FormatCvpcbNetlist( OUTPUTFORMATTER* aOut )
    {
        Format( "cvpcb_netlist", aOut, 0, CTL_FOR_CVPCB );
    }

    const std::vector<wxString>& GetVariantNames() const { return m_variantNames; }

    void AddVariant( const wxString& aName, const wxString& aDescription = wxEmptyString )
    {
        if( aName.IsEmpty() )
            return;
 
        for( const wxString& existingName : m_variantNames )
        {
            if( existingName.CmpNoCase( aName ) == 0 )
            {
                if( aDescription.IsEmpty() )
                    m_variantDescriptions.erase( existingName );
                else
                    m_variantDescriptions[existingName] = aDescription;
 
                return;
            }
        }
 
        m_variantNames.push_back( aName );
 
        if( aDescription.IsEmpty() )
            return;
 
        m_variantDescriptions[aName] = aDescription;
    }

    wxString GetVariantDescription( const wxString& aVariantName ) const
    {
        wxString actualName;
 
        for( const wxString& existingName : m_variantNames )
        {
            if( existingName.CmpNoCase( aVariantName ) == 0 )
            {
                actualName = existingName;
                break;
            }
        }
 
        if( !actualName.IsEmpty() )
        {
            auto it = m_variantDescriptions.find( actualName );
 
            if( it != m_variantDescriptions.end() )
                return it->second;
        }
 
        return wxEmptyString;
    }

    const std::map<wxString, wxString>& GetVariantDescriptions() const
    {
        return m_variantDescriptions;
    }
 
private:
    boost::ptr_vector<COMPONENT>     m_components;          // Components found in the netlist.
    boost::ptr_vector<NETLIST_GROUP> m_groups;              // Groups found in the netlist.
    std::map<wxString, wxString>     m_netSignals;
    std::map<wxString, std::vector<std::pair<wxString, wxString>>> m_netChainTerminals;
    std::map<wxString, wxString>     m_netChainNetClasses;
    std::map<wxString, wxString>     m_netChainColors;
    std::map<wxString, wxString>     m_signalChainClasses;
 
    std::vector<wxString>            m_variantNames;         // Variant names in order.
    std::map<wxString, wxString>     m_variantDescriptions;  // Variant descriptions.
 
    bool       m_findByTimeStamp;     // Associate components by KIID (or refdes if false)
    bool       m_replaceFootprints;   // Update footprints to match footprints defined in netlist
};
 
 
#endif   // PCB_NETLIST_H