common/netlist_reader/netlist.h

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/>.
 */
 
#ifndef NETLIST_H
#define NETLIST_H
 
#include <boost/ptr_container/ptr_vector.hpp>
#include <wx/arrstr.h>
#include <wx/string.h>
#include <json_common.h>
#include <unordered_set>
#include <set>
 
#include <lib_id.h>
#include <kiid.h>
#include <ctl_flags.h>
#include <jumper_group.h>
 
 
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;
    std::vector<KIID> members;
};
 

class COMPONENT
{
public:
    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;
    }
 
    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; }
 
    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; }
 
protected:
    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::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;
};
 

class NETLIST
{
public:
    NETLIST() :
        m_findByTimeStamp( false ),
        m_replaceFootprints( false )
    {
    }
 
    virtual ~NETLIST() = default;

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

    void Clear()
    {
        m_components.clear();
        m_groups.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 );

    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 );
    }
 
protected:
    boost::ptr_vector<COMPONENT>     m_components;          // Components found in the netlist.
    boost::ptr_vector<NETLIST_GROUP> m_groups;              // Groups found in the netlist.
 
    bool       m_findByTimeStamp;     // Associate components by KIID (or refdes if false)
    bool       m_replaceFootprints;   // Update footprints to match footprints defined in netlist
};
 
 
#endif   // NETLIST_H