net_settings.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * @author Jon Evans <[email protected]>
 *
 * 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 3 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 KICAD_NET_SETTINGS_H
#define KICAD_NET_SETTINGS_H
 
#include <functional>
#include <map>
#include <memory>
#include <set>
#include <vector>
 
#include <netclass.h>
#include <settings/nested_settings.h>
#include <eda_pattern_match.h>

enum class NET_CHAIN_SOURCE
{
    SCHEMATIC,
    BOARD
};

class KICOMMON_API NET_SETTINGS : public NESTED_SETTINGS
{
public:
    NET_SETTINGS( JSON_SETTINGS* aParent, const std::string& aPath );
 
    virtual ~NET_SETTINGS();
 
    bool operator==( const NET_SETTINGS& aOther ) const;
 
    bool operator!=( const NET_SETTINGS& aOther ) const { return !operator==( aOther ); }

    void CopyFrom( NET_SETTINGS& aOther );

    void SetDefaultNetclass( std::shared_ptr<NETCLASS> netclass );

    std::shared_ptr<NETCLASS> GetDefaultNetclass() const;

    bool HasNetclass( const wxString& netclassName ) const;

    void SetNetclass( const wxString& netclassName, std::shared_ptr<NETCLASS>& netclass );

    void SetNetclasses( const std::map<wxString, std::shared_ptr<NETCLASS>>& netclasses );

    const std::map<wxString, std::shared_ptr<NETCLASS>>& GetNetclasses() const;

    // Note the full connectivity or board net synchronisation must be run before calling
    // this, otherwise resolved netclasses may be missing
    const std::map<wxString, std::shared_ptr<NETCLASS>>& GetCompositeNetclasses() const;

    void ClearNetclasses();

    const std::map<wxString, std::set<wxString>>& GetNetclassLabelAssignments() const;

    void ClearNetclassLabelAssignments();

    void ClearNetclassLabelAssignment( const wxString& netName );

    void SetNetclassLabelAssignment( const wxString&           netName,
                                     const std::set<wxString>& netclasses );

    void AppendNetclassLabelAssignment( const wxString&           netName,
                                        const std::set<wxString>& netclasses );

    bool HasNetclassLabelAssignment( const wxString& netName ) const;

    void SetNetclassPatternAssignment( const wxString& pattern, const wxString& netclass );

    void SetNetclassPatternAssignments(
            std::vector<std::pair<std::unique_ptr<EDA_COMBINED_MATCHER>, wxString>>&&
                    netclassPatterns );

    std::vector<std::pair<std::unique_ptr<EDA_COMBINED_MATCHER>, wxString>>&
    GetNetclassPatternAssignments();

    void ClearNetclassPatternAssignments();

    void SetChainPatternAssignment( NET_CHAIN_SOURCE aSource, const wxString& pattern,
                                    const wxString& netclass );

    void ClearChainPatternAssignments( NET_CHAIN_SOURCE aSource );

    bool HasChainPatternAssignments( NET_CHAIN_SOURCE aSource ) const
    {
        auto it = m_netClassChainPatternAssignments.find( aSource );
        return it != m_netClassChainPatternAssignments.end() && !it->second.empty();
    }

    const auto& GetChainPatternAssignments() const { return m_netClassChainPatternAssignments; }

    void ClearCacheForNet( const wxString& netName );

    void ClearAllCaches();

    void SetNetColorAssignment( const wxString& netName, const KIGFX::COLOR4D& color );

    const std::map<wxString, KIGFX::COLOR4D>& GetNetColorAssignments() const;

    void ClearNetColorAssignments();

    bool RenameNetPathPrefix( const wxString& aOldPrefix, const wxString& aNewPrefix );

    bool RenameNets( const std::map<wxString, wxString>& aNewNames );

    void SetNetChainClass( const wxString& aChain, const wxString& aClass )
    {
        if( aClass.IsEmpty() )
            m_netChainClasses.erase( aChain );
        else
            m_netChainClasses[aChain] = aClass;
    }

    wxString GetNetChainClass( const wxString& aChain ) const
    {
        auto it = m_netChainClasses.find( aChain );
        return it != m_netChainClasses.end() ? it->second : wxString();
    }
 
    const std::map<wxString, wxString>& GetNetChainClasses() const
    {
        return m_netChainClasses;
    }

    void ClearNetChainClasses()
    {
        m_netChainClasses.clear();
    }

    void SetNetChainNetClass( const wxString& aChain, const wxString& aNetclass )
    {
        if( aNetclass.IsEmpty() )
            m_netChainNetClasses.erase( aChain );
        else
            m_netChainNetClasses[aChain] = aNetclass;
    }

    wxString GetNetChainNetClass( const wxString& aChain ) const
    {
        auto it = m_netChainNetClasses.find( aChain );
        return it != m_netChainNetClasses.end() ? it->second : wxString();
    }
 
    const std::map<wxString, wxString>& GetNetChainNetClasses() const
    {
        return m_netChainNetClasses;
    }

    void ClearNetChainNetClasses()
    {
        m_netChainNetClasses.clear();
    }

    bool HasEffectiveNetClass( const wxString& aNetName ) const;

    std::shared_ptr<NETCLASS> GetCachedEffectiveNetClass( const wxString& aNetName ) const;

    // If the effective netclass has not been computed, it will be created and cached.
    std::shared_ptr<NETCLASS> GetEffectiveNetClass( const wxString& aNetName );

    void RecomputeEffectiveNetclasses();

    std::shared_ptr<NETCLASS> GetNetClassByName( const wxString& aNetName ) const;

    static bool ParseBusVector( const wxString& aBus, wxString* aName,
                                std::vector<wxString>* aMemberList );

    static bool ParseBusGroup( const wxString& aGroup, wxString* name,
                               std::vector<wxString>* aMemberList, size_t* aPrefixEnd = nullptr );

    static void ForEachBusMember( const wxString&                        aBusPattern,
                                  const std::function<void( const wxString& )>& aFunction );
 
private:
    bool migrateSchema0to1();
    bool migrateSchema1to2();
    bool migrateSchema2to3();
    bool migrateSchema3to4();
    bool migrateSchema4to5();

    void makeEffectiveNetclass( std::shared_ptr<NETCLASS>& effectiveNetclass,
                                std::vector<NETCLASS*>&    netclasses ) const;

    bool addMissingDefaults( NETCLASS* nc ) const;

    void addSinglePatternAssignment( const wxString& pattern, const wxString& netclass );

    void addSingleChainPatternAssignment( NET_CHAIN_SOURCE aSource, const wxString& pattern,
                                          const wxString& netclass );

    std::shared_ptr<NETCLASS> m_defaultNetClass;

    std::map<wxString, std::shared_ptr<NETCLASS>> m_netClasses;

    std::map<wxString, std::set<wxString>> m_netClassLabelAssignments;

    std::vector<std::pair<std::unique_ptr<EDA_COMBINED_MATCHER>, wxString>>
            m_netClassPatternAssignments;

    std::map<NET_CHAIN_SOURCE,
             std::vector<std::pair<std::unique_ptr<EDA_COMBINED_MATCHER>, wxString>>>
            m_netClassChainPatternAssignments;

    // composite (multiple netclass assignment / missing defaults) netclasses
    std::map<wxString, std::shared_ptr<NETCLASS>> m_compositeNetClasses;

    // to the effective netclasses which contain them.
    std::map<wxString, std::shared_ptr<NETCLASS>> m_impicitNetClasses;

    std::map<wxString, std::shared_ptr<NETCLASS>> m_effectiveNetclassCache;

    std::map<wxString, std::set<wxString>> m_netclassBusMembers;

    std::map<wxString, KIGFX::COLOR4D> m_netColorAssignments;

    std::map<wxString, wxString> m_netChainClasses;

    std::map<wxString, wxString> m_netChainNetClasses;
 
    // TODO: Add diff pairs, bus information, etc.
};
 
#endif // KICAD_NET_SETTINGS_H