component_class_manager.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 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 PCBNEW_COMPONENT_CLASS_MANAGER_H
#define PCBNEW_COMPONENT_CLASS_MANAGER_H
 
#include <unordered_map>
#include <unordered_set>
#include <wx/string.h>
 
#include <component_classes/component_class.h>
#include <project/component_class_settings.h>
 
 
class BOARD;
class COMPONENT_CLASS_ASSIGNMENT_RULE;
class DRC_TOOL;
class FOOTPRINT;

class COMPONENT_CLASS_MANAGER
{
public:
    explicit COMPONENT_CLASS_MANAGER( BOARD* board );

    static wxString GetFullClassNameForConstituents( const std::unordered_set<wxString>& classNames );

    static wxString GetFullClassNameForConstituents( const std::vector<wxString>& classNames );

    COMPONENT_CLASS* GetEffectiveStaticComponentClass( const std::unordered_set<wxString>& classNames );

    const COMPONENT_CLASS* GetNoneComponentClass() const { return m_noneClass.get(); }

    void InitNetlistUpdate();

    void FinishNetlistUpdate();

    std::unordered_set<wxString> GetClassNames() const;

    bool SyncDynamicComponentClassAssignments(
            const std::vector<COMPONENT_CLASS_ASSIGNMENT_DATA>& aAssignments,
            bool aGenerateSheetClasses, const std::unordered_set<wxString>& aNewSheetPaths );

    const COMPONENT_CLASS* GetDynamicComponentClassesForFootprint( const FOOTPRINT* footprint );

    const COMPONENT_CLASS* GetCombinedComponentClass( const COMPONENT_CLASS* staticClass,
                                                      const COMPONENT_CLASS* dynamicClass );

    void ForceComponentClassRecalculation() const;

    long long int GetTicker() const { return m_ticker; }

    void InvalidateComponentClasses();

    void RebuildRequiredCaches( FOOTPRINT* aFootprint = nullptr ) const;
 
    static std::shared_ptr<COMPONENT_CLASS_ASSIGNMENT_RULE>
    CompileAssignmentRule( const COMPONENT_CLASS_ASSIGNMENT_DATA& aAssignment );
 
protected:
    static std::vector<wxString> sortClassNames( const std::unordered_set<wxString>& classNames );

    COMPONENT_CLASS* getOrCreateConstituentClass( const wxString&        aClassName,
                                                  COMPONENT_CLASS::USAGE aContext );

    COMPONENT_CLASS* getOrCreateEffectiveClass( const std::vector<wxString>& aClassNames,
                                                COMPONENT_CLASS::USAGE       aContext );

    BOARD* m_board;

    std::shared_ptr<COMPONENT_CLASS> m_noneClass;

    std::unordered_map<wxString, std::unique_ptr<COMPONENT_CLASS>> m_constituentClasses;

    std::unordered_map<wxString, std::unique_ptr<COMPONENT_CLASS>> m_effectiveClasses;

    std::unordered_set<wxString> m_staticClassNamesCache;
 

    std::vector<std::shared_ptr<COMPONENT_CLASS_ASSIGNMENT_RULE>> m_assignmentRules;

    long long int m_ticker{ 0 };
};
 
#endif