topo_match.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 __TOPO_MATCH_H
#define __TOPO_MATCH_H
 
#include <atomic>
#include <vector>
#include <map>
#include <unordered_map>
#include <unordered_set>
#include <optional>
 
#include <wx/string.h>
 
class FOOTPRINT;
 
/* A very simple (but working) partial connection graph isomorphism algorithm,
   operating on sets of footprints and connections between their pads.
*/
 
namespace TMATCH
{
 
class PIN;
class CONNECTION_GRAPH;
 
struct ISOMORPHISM_PARAMS
{
    std::atomic<bool>* m_cancelled = nullptr;
    std::atomic<int>*  m_matchedComponents = nullptr;
    std::atomic<int>*  m_totalComponents = nullptr;
};
 
struct TOPOLOGY_MISMATCH_REASON
{
    wxString m_reference;
    wxString m_candidate;
    wxString m_reason;
};
 
class COMPONENT
{
    friend class PIN;
    friend class CONNECTION_GRAPH;
 
public:
    COMPONENT( const wxString& aRef, FOOTPRINT* aParentFp, std::optional<VECTOR2I> aRaOffset = std::optional<VECTOR2I>() );
    ~COMPONENT();
 
    bool               IsSameKind( const COMPONENT& b ) const;
    void               AddPin( PIN* p );
    int                GetPinCount() const { return m_pins.size(); }
    bool               MatchesWith( COMPONENT* b, TOPOLOGY_MISMATCH_REASON& aDetail );
    std::vector<PIN*>& Pins() { return m_pins; }
    FOOTPRINT* GetParent() const { return m_parentFootprint; }
 
    bool HasRAOffset() const { return m_raOffset.has_value(); }
    const VECTOR2I GetRAOffset() const { return *m_raOffset; }
 
private:
    void sortPinsByName();

    static bool isChannelSuffix( const wxString& aSuffix );

    static bool prefixesShareCommonBase( const wxString& aPrefixA, const wxString& aPrefixB );

    static bool isUnannotatedRef( const wxString& aRef );
 
    std::optional<VECTOR2I> m_raOffset;
    wxString          m_reference;
    wxString          m_prefix;
    FOOTPRINT*        m_parentFootprint = nullptr;
    std::vector<PIN*> m_pins;
};
 
class PIN
{
    friend class CONNECTION_GRAPH;
 
public:
    PIN() : m_netcode( 0 ), m_parent( nullptr ) {}
    ~PIN() {}
 
    void SetParent( COMPONENT* parent ) { m_parent = parent; }
 
    const wxString Format() const { return m_parent->m_reference + wxT( "-" ) + m_ref; }
 
    void AddConnection( PIN* pin ) { m_conns.push_back( pin ); }
 
    bool IsTopologicallySimilar( const PIN& b ) const
    {
        wxASSERT( m_parent != b.m_parent );
 
        if( !m_parent->IsSameKind( *b.m_parent ) )
            return false;
 
        return m_ref == b.m_ref;
    }
 
    bool IsIsomorphic( const PIN& b, TOPOLOGY_MISMATCH_REASON& aDetail ) const;
 
    int GetNetCode() const { return m_netcode; }
 
    const wxString& GetReference() const { return m_ref; }
 
    COMPONENT* GetParent() const { return m_parent; }
 
private:
 
    wxString          m_ref;
    int               m_netcode;
    COMPONENT*        m_parent;
    std::vector<PIN*> m_conns;
};
 
class BACKTRACK_STAGE
{
    friend class CONNECTION_GRAPH;
 
public:
    BACKTRACK_STAGE()
    {
        m_ref = nullptr;
        m_currentMatch = -1;
        m_nloops = 0;
        m_refIndex = 0;
    }
 
    BACKTRACK_STAGE( const BACKTRACK_STAGE& other )
    {
        m_currentMatch = other.m_currentMatch;
        m_ref = other.m_ref;
        m_matches = other.m_matches;
        m_locked = other.m_locked;
        m_nloops = other.m_nloops;
        m_refIndex = other.m_refIndex;
    }
 
    const std::unordered_map<COMPONENT*, COMPONENT*>& GetMatchingComponentPairs() const
    {
        return m_locked;
    }
 
private:
    COMPONENT*                       m_ref;
    int                              m_currentMatch = -1;
    int                              m_nloops;
    std::vector<COMPONENT*>          m_matches;
    std::unordered_map<COMPONENT*, COMPONENT*> m_locked;
    int m_refIndex;
};
 
typedef std::map<FOOTPRINT*, FOOTPRINT*> COMPONENT_MATCHES;
 
class CONNECTION_GRAPH
{
public:
    const int c_ITER_LIMIT = 10000;
 
    CONNECTION_GRAPH();
    ~CONNECTION_GRAPH();
 
    void   BuildConnectivity( const std::unordered_set<int>& aExternalNets = {} );
    void   AddFootprint( FOOTPRINT* aFp, const VECTOR2I& aOffset );
    bool   FindIsomorphism( CONNECTION_GRAPH* target, COMPONENT_MATCHES& result,
                            std::vector<TOPOLOGY_MISMATCH_REASON>& aFailureDetails,
                            const ISOMORPHISM_PARAMS& aParams = {} );
    static std::unique_ptr<CONNECTION_GRAPH> BuildFromFootprintSet( const std::set<FOOTPRINT*>& aFps,
                                                                     const std::set<FOOTPRINT*>& aOtherChannelFps = {},
                                                                     const std::unordered_set<int>& aGlobalNets = {} );
    std::vector<COMPONENT*> &Components() { return m_components; }
 
private:
    void breakTie( COMPONENT* aRef, std::vector<COMPONENT*>& aMatches ) const;
    bool breakTieBySymbolUuid( COMPONENT* aRef, std::vector<COMPONENT*>& aMatches ) const;

    bool breakTieByValue( COMPONENT* aRef, std::vector<COMPONENT*>& aMatches ) const;
 
    void sortByPinCount();
 
 
    std::vector<COMPONENT*> findMatchingComponents( COMPONENT*                     ref,
                                                    const std::vector<COMPONENT*>& aStructuralMatches,
                                                    const TOPOLOGY_MISMATCH_REASON& aStructuralReason,
                                                    const BACKTRACK_STAGE&         partialMatches,
                                                    std::vector<TOPOLOGY_MISMATCH_REASON>& aFailureDetails,
                                                    const std::atomic<bool>* aCancelled = nullptr );
 
    std::vector<COMPONENT*>   m_components;
    std::unordered_set<int>   m_externalNets;
 
};
 
}; // namespace TMATCH
 
#endif