symbol_import_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 <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <functional>
#include <map>
#include <memory>
#include <set>
#include <vector>
#include <wx/string.h>
 
class LIB_SYMBOL;
 

struct SYMBOL_IMPORT_INFO
{
    wxString                    m_name;           
    std::unique_ptr<LIB_SYMBOL> m_symbol;         
    wxString                    m_parentName;     
    bool                        m_isPower;        
    bool                        m_existsInDest;   
    bool                        m_checked;        
    bool                        m_autoSelected;   
 
    SYMBOL_IMPORT_INFO() :
            m_isPower( false ),
            m_existsInDest( false ),
            m_checked( false ),
            m_autoSelected( false )
    {
    }
};
 

enum class CONFLICT_RESOLUTION
{
    SKIP,      
    OVERWRITE  
};
 

class SYMBOL_IMPORT_MANAGER
{
public:
    using SYMBOL_EXISTS_FUNC = std::function<bool( const wxString& symbolName )>;
 
    SYMBOL_IMPORT_MANAGER();
    ~SYMBOL_IMPORT_MANAGER();

    void Clear();

    void AddSymbol( const wxString& aName, const wxString& aParentName, bool aIsPower,
                    LIB_SYMBOL* aSymbol = nullptr );

    void CheckExistingSymbols( SYMBOL_EXISTS_FUNC aExistsFunc );

    void BuildDependencyMaps();

    std::vector<wxString> GetSymbolNames() const;

    SYMBOL_IMPORT_INFO* GetSymbolInfo( const wxString& aName );
    const SYMBOL_IMPORT_INFO* GetSymbolInfo( const wxString& aName ) const;

    std::set<wxString> GetAncestors( const wxString& aSymbolName ) const;

    std::set<wxString> GetDescendants( const wxString& aSymbolName ) const;

    wxString GetParent( const wxString& aSymbolName ) const;

    std::vector<wxString> GetDirectDerivatives( const wxString& aSymbolName ) const;

    bool IsDerived( const wxString& aSymbolName ) const;

    std::vector<wxString> SetSymbolSelected( const wxString& aSymbolName, bool aSelected );

    std::vector<wxString> GetSelectedDescendants( const wxString& aSymbolName ) const;

    void DeselectWithDescendants( const wxString& aSymbolName );

    void SelectAll( std::function<bool( const wxString& )> aFilter = nullptr );

    void DeselectAll( std::function<bool( const wxString& )> aFilter = nullptr );

    std::vector<wxString> GetSymbolsToImport() const;

    int GetManualSelectionCount() const;

    int GetAutoSelectionCount() const;

    std::vector<wxString> GetConflicts() const;

    static bool MatchesFilter( const wxString& aSymbolName, const wxString& aFilter );

    size_t GetSymbolCount() const { return m_symbols.size(); }
 
private:
    void recalculateAutoSelections();

    std::map<wxString, SYMBOL_IMPORT_INFO> m_symbols;

    std::map<wxString, wxString> m_parentMap;

    std::map<wxString, std::vector<wxString>> m_derivativesMap;
};