lib_tree_model.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 Chris Pavlina <[email protected]>
 * Copyright (C) 2014 Henner Zeller <[email protected]>
 * Copyright (C) 2023 CERN
 * Copyright (C) 2014-2023 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/>.
 */
 
#ifndef LIB_TREE_MODEL_H
#define LIB_TREE_MODEL_H
 
#include <vector>
#include <map>
#include <memory>
#include <wx/string.h>
#include <eda_pattern_match.h>
#include <lib_tree_item.h>
 
 
class LIB_TREE_NODE
{
public:
 virtual void UpdateScore( EDA_COMBINED_MATCHER* aMatcher, const wxString& aLib,
 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter ) = 0;
 
 virtual void ResetScore();
 
 virtual void ForceScore( int aScore ) { m_Score = aScore; }
 
 void AssignIntrinsicRanks( bool presorted = false );
 
 void SortNodes( bool aUseScores );
 
 static bool Compare( LIB_TREE_NODE const& aNode1, LIB_TREE_NODE const& aNode2,
 bool aUseScores );
 
 LIB_TREE_NODE();
 virtual ~LIB_TREE_NODE() {}
 
 enum TYPE
 {
 ROOT,
 LIBRARY,
 ITEM,
 UNIT,
 INVALID
 };
 
 typedef std::vector<std::unique_ptr<LIB_TREE_NODE>> PTR_VECTOR;
 
 LIB_TREE_NODE* m_Parent; // Parent node or null
 PTR_VECTOR m_Children; // List of child nodes
 enum TYPE m_Type; // Node type
 
 int m_IntrinsicRank;
 
 int m_Score; // The score of an item resulting from the search algorithm.
 bool m_Pinned; // Item should appear at top when there is no search string
 
 wxString m_Name; // Actual name of the part
 wxString m_Desc; // Description to be displayed
 wxString m_Footprint; // Footprint ID as a string (ie: the footprint field text)
 int m_PinCount; // Pin count from symbol, or unique pad count from footprint
 
 std::vector<SEARCH_TERM> m_SearchTerms; 
 std::map<wxString, wxString> m_Fields; 
 
 LIB_ID m_LibId; // LIB_ID determined by the parent library nickname and alias name.
 int m_Unit; // Actual unit, or zero
 bool m_IsRoot; // Indicates if the symbol is a root symbol instead of an alias.
};
 
 
class LIB_TREE_NODE_UNIT: public LIB_TREE_NODE
{
public:
 LIB_TREE_NODE_UNIT( LIB_TREE_NODE_UNIT const& _ ) = delete;
 void operator=( LIB_TREE_NODE_UNIT const& _ ) = delete;
 
 LIB_TREE_NODE_UNIT( LIB_TREE_NODE* aParent, LIB_TREE_ITEM* aItem, int aUnit );
 
 void UpdateScore( EDA_COMBINED_MATCHER* aMatcher, const wxString& aLib,
 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter ) override;
};
 
 
class LIB_TREE_NODE_ITEM : public LIB_TREE_NODE
{
public:
 LIB_TREE_NODE_ITEM( LIB_TREE_NODE_ITEM const& _ ) = delete;
 void operator=( LIB_TREE_NODE_ITEM const& _ ) = delete;
 
 LIB_TREE_NODE_ITEM( LIB_TREE_NODE* aParent, LIB_TREE_ITEM* aItem );
 
 void Update( LIB_TREE_ITEM* aItem );
 
 void UpdateScore( EDA_COMBINED_MATCHER* aMatcher, const wxString& aLib,
 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter ) override;
 
protected:
 LIB_TREE_NODE_UNIT& AddUnit( LIB_TREE_ITEM* aItem, int aUnit );
};
 
 
class LIB_TREE_NODE_LIBRARY : public LIB_TREE_NODE
{
public:
 LIB_TREE_NODE_LIBRARY( LIB_TREE_NODE_LIBRARY const& _ ) = delete;
 void operator=( LIB_TREE_NODE_LIBRARY const& _ ) = delete;
 
 LIB_TREE_NODE_LIBRARY( LIB_TREE_NODE* aParent, const wxString& aName, const wxString& aDesc );
 
 LIB_TREE_NODE_ITEM& AddItem( LIB_TREE_ITEM* aItem );
 
 void UpdateScore( EDA_COMBINED_MATCHER* aMatcher, const wxString& aLib,
 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter ) override;
};
 
 
class LIB_TREE_NODE_ROOT: public LIB_TREE_NODE
{
public:
 LIB_TREE_NODE_ROOT( LIB_TREE_NODE_ROOT const& _ ) = delete;
 void operator=( LIB_TREE_NODE_ROOT const& _ ) = delete;
 
 LIB_TREE_NODE_ROOT();
 
 LIB_TREE_NODE_LIBRARY& AddLib( wxString const& aName, wxString const& aDesc );
 
 void UpdateScore( EDA_COMBINED_MATCHER* aMatcher, const wxString& aLib,
 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter ) override;
};
 
 
#endif // LIB_TREE_MODEL_H