KiCad PCB EDA Suite
Loading...
Searching...
No Matches
lib_tree_model.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2017 Chris Pavlina <[email protected]>
5 * Copyright (C) 2014 Henner Zeller <[email protected]>
6 * Copyright (C) 2023 CERN
7 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software: you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation, either version 3 of the License, or (at your
12 * option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23#include <lib_tree_model.h>
24
25#include <algorithm>
26#include <core/kicad_algo.h>
27#include <eda_pattern_match.h>
28#include <lib_tree_item.h>
29#include <pgm_base.h>
30#include <string_utils.h>
31
32
33
34void LIB_TREE_NODE::RebuildSearchTerms( const std::vector<wxString>& aShownColumns )
35{
37
38 for( const auto& [name, value] : m_Fields )
39 {
40 if( alg::contains( aShownColumns, name ) )
41 m_SearchTerms.push_back( SEARCH_TERM( value, 4 ) );
42 }
43}
44
45
46void LIB_TREE_NODE::AssignIntrinsicRanks( const std::vector<wxString>& aShownColumns, bool presorted )
47{
48 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
49 child->RebuildSearchTerms( aShownColumns );
50
51 std::vector<LIB_TREE_NODE*> sort_buf;
52
53 if( presorted )
54 {
55 int max = m_Children.size() - 1;
56
57 for( int i = 0; i <= max; ++i )
58 m_Children[i]->m_IntrinsicRank = max - i;
59 }
60 else
61 {
62 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
63 sort_buf.push_back( child.get() );
64
65 std::sort( sort_buf.begin(), sort_buf.end(),
66 []( LIB_TREE_NODE* a, LIB_TREE_NODE* b ) -> bool
67 {
68 return StrNumCmp( a->m_Name, b->m_Name, true ) > 0;
69 } );
70
71 for( int i = 0; i < (int) sort_buf.size(); ++i )
72 sort_buf[i]->m_IntrinsicRank = i;
73 }
74}
75
76
77void LIB_TREE_NODE::SortNodes( bool aUseScores )
78{
79 std::sort( m_Children.begin(), m_Children.end(),
80 [&]( std::unique_ptr<LIB_TREE_NODE>& a, std::unique_ptr<LIB_TREE_NODE>& b )
81 {
82 return Compare( *a, *b, aUseScores );
83 } );
84
85 for( std::unique_ptr<LIB_TREE_NODE>& node: m_Children )
86 node->SortNodes( aUseScores );
87}
88
89
90bool LIB_TREE_NODE::Compare( LIB_TREE_NODE const& aNode1, LIB_TREE_NODE const& aNode2,
91 bool aUseScores )
92{
93 if( aNode1.m_Type != aNode2.m_Type )
94 return aNode1.m_Type < aNode2.m_Type;
95
96 // Recently used sorts at top
97 if( aNode1.m_IsRecentlyUsedGroup )
98 {
99 if( aNode2.m_IsRecentlyUsedGroup )
100 {
101 // Make sure "-- Recently Used" is always at the top
102 // Start by checking the name of aNode2, because we want to satisfy the irreflexive
103 // property of the strict weak ordering.
104 if( aNode2.m_IsRecentlyUsedGroup )
105 return false;
106 else if( aNode1.m_IsRecentlyUsedGroup )
107 return true;
108
109 return aNode1.m_IntrinsicRank > aNode2.m_IntrinsicRank;
110 }
111 else
112 {
113 return true;
114 }
115 }
116 else if( aNode2.m_Name.StartsWith( wxT( "-- " ) ) )
117 {
118 return false;
119 }
120
121 // Pinned nodes go next
122 if( aNode1.m_Pinned && !aNode2.m_Pinned )
123 return true;
124 else if( aNode2.m_Pinned && !aNode1.m_Pinned )
125 return false;
126
127 if( aUseScores && aNode1.m_Score != aNode2.m_Score )
128 return aNode1.m_Score > aNode2.m_Score;
129
130 if( aNode1.m_IntrinsicRank != aNode2.m_IntrinsicRank )
131 return aNode1.m_IntrinsicRank > aNode2.m_IntrinsicRank;
132
133 return reinterpret_cast<const void*>( &aNode1 ) < reinterpret_cast<const void*>( &aNode2 );
134}
135
136
138 : m_Parent( nullptr ),
139 m_Type( TYPE::INVALID ),
140 m_IntrinsicRank( 0 ),
141 m_Score( 0 ),
142 m_Pinned( false ),
143 m_PinCount( 0 ),
144 m_Unit( 0 ),
145 m_IsRoot( false ),
146 m_IsRecentlyUsedGroup( false ),
147 m_IsAlreadyPlacedGroup( false )
148{}
149
150
152{
153 m_Parent = aParent;
154 m_Type = TYPE::UNIT;
155
156 m_Unit = aUnit;
157 m_LibId = aParent->m_LibId;
158 m_Name = aItem->GetUnitName( aUnit );
159
160 m_IntrinsicRank = -aUnit;
161}
162
163
164void LIB_TREE_NODE_UNIT::UpdateScore( const std::vector<std::unique_ptr<EDA_COMBINED_MATCHER>>& aMatchers,
165 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter )
166{
167 m_Score = 1;
168
169 // aMatchers test results are inherited from parent
170 if( !aMatchers.empty() )
172
173 if( aFilter && !(*aFilter)(*this) )
174 m_Score = 0;
175}
176
177
179{
180 m_Type = TYPE::ITEM;
181 m_Parent = aParent;
182
184 m_LibId.SetLibItemName( aItem->GetName() );
185
186 m_Name = aItem->GetName();
187 m_Desc = aItem->GetDesc();
188 m_Footprint = aItem->GetFootprint();
189 m_PinCount = aItem->GetPinCount();
190
191 aItem->GetChooserFields( m_Fields );
192
194
195 m_IsRoot = aItem->IsRoot();
196
197 if( aItem->GetSubUnitCount() > 1 )
198 {
199 for( int u = 1; u <= aItem->GetSubUnitCount(); ++u )
200 AddUnit( aItem, u );
201 }
202}
203
204
206{
207 LIB_TREE_NODE_UNIT* unit = new LIB_TREE_NODE_UNIT( this, aItem, aUnit );
208 m_Children.push_back( std::unique_ptr<LIB_TREE_NODE>( unit ) );
209 return *unit;
210}
211
212
214{
216 m_LibId.SetLibItemName( aItem->GetName() );
217
218 m_Name = aItem->GetName();
219 m_Desc = aItem->GetDesc();
220
221 aItem->GetChooserFields( m_Fields );
222
224
225 m_IsRoot = aItem->IsRoot();
226 m_Children.clear();
227
228 for( int u = 1; u <= aItem->GetSubUnitCount(); ++u )
229 AddUnit( aItem, u );
230}
231
232
233void LIB_TREE_NODE_ITEM::UpdateScore( const std::vector<std::unique_ptr<EDA_COMBINED_MATCHER>>& aMatchers,
234 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter )
235{
236 m_Score = 1;
237
238 for( const std::unique_ptr<EDA_COMBINED_MATCHER>& matcher : aMatchers )
239 {
240 int score = matcher->ScoreTerms( m_SearchTerms );
241
242 if( score == 0 )
243 {
244 m_Score = 0;
245 break;
246 }
247
248 m_Score += score;
249 }
250
251 if( aFilter && !(*aFilter)(*this) )
252 m_Score = 0;
253
254 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
255 child->UpdateScore( aMatchers, aFilter );
256}
257
258
260 wxString const& aDesc )
261{
262 m_Type = TYPE::LIBRARY;
263 m_Name = aName;
264 m_Desc = aDesc;
265 m_Parent = aParent;
266 m_LibId.SetLibNickname( aName );
267
268 m_SearchTerms.emplace_back( SEARCH_TERM( aName, 8 ) );
269}
270
271
273{
274 LIB_TREE_NODE_ITEM* item = new LIB_TREE_NODE_ITEM( this, aItem );
275 m_Children.push_back( std::unique_ptr<LIB_TREE_NODE>( item ) );
276 return *item;
277}
278
279
280void LIB_TREE_NODE_LIBRARY::UpdateScore( const std::vector<std::unique_ptr<EDA_COMBINED_MATCHER>>& aMatchers,
281 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter )
282{
283 if( m_Children.empty() )
284 {
285 m_Score = 1;
286
287 for( const std::unique_ptr<EDA_COMBINED_MATCHER>& matcher : aMatchers )
288 {
289 int score = matcher->ScoreTerms( m_SearchTerms );
290
291 if( score == 0 )
292 {
293 m_Score = 0;
294 break;
295 }
296
297 m_Score += score;
298 }
299 }
300 else
301 {
302 m_Score = 0;
303
304 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
305 {
306 child->UpdateScore( aMatchers, aFilter );
307 m_Score = std::max( m_Score, child->m_Score );
308 }
309 }
310}
311
312
314{
315 m_Type = TYPE::ROOT;
316}
317
318
319LIB_TREE_NODE_LIBRARY& LIB_TREE_NODE_ROOT::AddLib( wxString const& aName, wxString const& aDesc )
320{
321 LIB_TREE_NODE_LIBRARY* lib = new LIB_TREE_NODE_LIBRARY( this, aName, aDesc );
322 m_Children.push_back( std::unique_ptr<LIB_TREE_NODE>( lib ) );
323 return *lib;
324}
325
326
327void LIB_TREE_NODE_ROOT::RemoveGroup( bool aRecentlyUsedGroup, bool aAlreadyPlacedGroup )
328{
329 m_Children.erase( std::remove_if( m_Children.begin(), m_Children.end(),
330 [&]( std::unique_ptr<LIB_TREE_NODE>& aNode )
331 {
332 if( aRecentlyUsedGroup && aNode->m_IsRecentlyUsedGroup )
333 return true;
334
335 if( aAlreadyPlacedGroup && aNode->m_IsAlreadyPlacedGroup )
336 return true;
337
338 return false;
339 } ),
340 m_Children.end() );
341}
342
343
345{
346 m_Children.clear();
347}
348
349
350void LIB_TREE_NODE_ROOT::UpdateScore( const std::vector<std::unique_ptr<EDA_COMBINED_MATCHER>>& aMatchers,
351 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter )
352{
353 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
354 child->UpdateScore( aMatchers, aFilter );
355}
356
const char * name
Definition: DXF_plotter.cpp:62
int SetLibItemName(const UTF8 &aLibItemName)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:111
int SetLibNickname(const UTF8 &aLibNickname)
Override the logical library name portion of the LIB_ID to aLibNickname.
Definition: lib_id.cpp:100
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:87
A mix-in to provide polymorphism between items stored in libraries (symbols, aliases and footprints).
Definition: lib_tree_item.h:41
virtual wxString GetLibNickname() const =0
virtual int GetSubUnitCount() const
For items with units, return the number of units.
Definition: lib_tree_item.h:79
virtual wxString GetUnitName(int aUnit) const
For items with units, return an identifier for unit x.
Definition: lib_tree_item.h:84
virtual std::vector< SEARCH_TERM > GetSearchTerms()
Definition: lib_tree_item.h:59
virtual wxString GetFootprint()
For items with footprint fields.
Definition: lib_tree_item.h:69
virtual LIB_ID GetLIB_ID() const =0
virtual wxString GetDesc()=0
virtual bool IsRoot() const
For items having aliases, IsRoot() indicates the principal item.
Definition: lib_tree_item.h:64
virtual wxString GetName() const =0
virtual int GetPinCount()
The pin count for symbols or the unique pad count for footprints.
Definition: lib_tree_item.h:74
virtual void GetChooserFields(std::map< wxString, wxString > &aColumnMap)
Retrieves a key/value map of the fields on this item that should be exposed to the library browser/ch...
Definition: lib_tree_item.h:57
Node type: LIB_ID.
void UpdateScore(const std::vector< std::unique_ptr< EDA_COMBINED_MATCHER > > &aMatchers, std::function< bool(LIB_TREE_NODE &aNode)> *aFilter) override
Perform the actual search.
LIB_TREE_NODE_ITEM(LIB_TREE_NODE_ITEM const &_)=delete
The addresses of CMP_TREE_NODEs are used as unique IDs for the wxDataViewModel, so don't let them be ...
LIB_TREE_NODE_UNIT & AddUnit(LIB_TREE_ITEM *aItem, int aUnit)
Add a new unit to the component and return it.
void Update(LIB_TREE_ITEM *aItem)
Update the node using data from a LIB_ALIAS object.
Node type: library.
LIB_TREE_NODE_LIBRARY(LIB_TREE_NODE_LIBRARY const &_)=delete
The addresses of CMP_TREE_NODEs are used as unique IDs for the wxDataViewModel, so don't let them be ...
void UpdateScore(const std::vector< std::unique_ptr< EDA_COMBINED_MATCHER > > &aMatchers, std::function< bool(LIB_TREE_NODE &aNode)> *aFilter) override
Update the score for this part.
LIB_TREE_NODE_ITEM & AddItem(LIB_TREE_ITEM *aItem)
Construct a new alias node, add it to this library, and return it.
void RemoveGroup(bool aRecentlyUsedGroup, bool aAlreadyPlacedGroup)
Remove a library node from the root.
LIB_TREE_NODE_LIBRARY & AddLib(wxString const &aName, wxString const &aDesc)
Construct an empty library node, add it to the root, and return it.
LIB_TREE_NODE_ROOT()
Construct the root node.
void UpdateScore(const std::vector< std::unique_ptr< EDA_COMBINED_MATCHER > > &aMatchers, std::function< bool(LIB_TREE_NODE &aNode)> *aFilter) override
Update the score for this part.
void Clear()
Clear the tree.
Node type: unit of component.
LIB_TREE_NODE_UNIT(LIB_TREE_NODE_UNIT const &_)=delete
The addresses of CMP_TREE_NODEs are used as unique IDs for the wxDataViewModel, so don't let them be ...
void UpdateScore(const std::vector< std::unique_ptr< EDA_COMBINED_MATCHER > > &aMatchers, std::function< bool(LIB_TREE_NODE &aNode)> *aFilter) override
Update the score for this part.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
void SortNodes(bool aUseScores)
Sort child nodes quickly and recursively (IntrinsicRanks must have been set).
void RebuildSearchTerms(const std::vector< wxString > &aShownColumns)
Rebuild search terms from source search terms and shown fields.
static bool Compare(LIB_TREE_NODE const &aNode1, LIB_TREE_NODE const &aNode2, bool aUseScores)
Compare two nodes.
enum TYPE m_Type
std::vector< SEARCH_TERM > m_sourceSearchTerms
bool m_IsRecentlyUsedGroup
std::vector< SEARCH_TERM > m_SearchTerms
std::map< wxString, wxString > m_Fields
List of weighted search terms.
PTR_VECTOR m_Children
wxString m_Footprint
LIB_TREE_NODE * m_Parent
int m_IntrinsicRank
The rank of the item before any search terms are applied.
void AssignIntrinsicRanks(const std::vector< wxString > &aShownColumns, bool presorted=false)
Store intrinsic ranks on all children of this node.
Abstract pattern-matching tool and implementations.
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:100
see class PGM_BASE
A structure for storing weighted search terms.