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 (C) 2021-2022 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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_NET_SETTINGS_H
#define KICAD_NET_SETTINGS_H
 
#include <vector>
#include <set>
#include <memory>
#include <map>
 
#include <netclass.h>
#include <settings/nested_settings.h>
#include <eda_pattern_match.h>
 
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 SetDefaultNetclass( std::shared_ptr<NETCLASS> netclass );
 
    std::shared_ptr<NETCLASS> GetDefaultNetclass();
 
    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 ClearCacheForNet( const wxString& netName );
 
    // @brief Clears the effective netclass cache for all nets
    void ClearAllCaches();
 
    void SetNetColorAssignment( const wxString& netName, const KIGFX::COLOR4D& color );
 
    const std::map<wxString, KIGFX::COLOR4D>& GetNetColorAssignments() const;
 
    void ClearNetColorAssignments();
 
    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 );
 
    // Called when a value of a user-defined netclass changes, but the whole netclass list is not
    // being recomputed.
    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 );
 
private:
    bool migrateSchema0to1();
    bool migrateSchema1to2();
    bool migrateSchema2to3();
    bool migrateSchema3to4();
 
    void makeEffectiveNetclass( std::shared_ptr<NETCLASS>& effectiveNetclass,
                                std::vector<NETCLASS*>&    netclasses ) const;
 
    bool addMissingDefaults( NETCLASS* nc ) const;
 
    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;
 
    // 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, KIGFX::COLOR4D> m_netColorAssignments;
 
    // TODO: Add diff pairs, bus information, etc.
};
 
#endif // KICAD_NET_SETTINGS_H