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 (C) 2014-2023 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 <eda_pattern_match.h>
27#include <lib_tree_item.h>
28#include <pgm_base.h>
29#include <string_utils.h>
30
31
32
34{
35 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
36 child->ResetScore();
37
38 m_Score = 0;
39}
40
41
43{
44 std::vector<LIB_TREE_NODE*> sort_buf;
45
46 if( presorted )
47 {
48 int max = m_Children.size() - 1;
49
50 for( int i = 0; i <= max; ++i )
51 m_Children[i]->m_IntrinsicRank = max - i;
52 }
53 else
54 {
55 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
56 sort_buf.push_back( child.get() );
57
58 std::sort( sort_buf.begin(), sort_buf.end(),
59 []( LIB_TREE_NODE* a, LIB_TREE_NODE* b ) -> bool
60 {
61 return StrNumCmp( a->m_Name, b->m_Name, true ) > 0;
62 } );
63
64 for( int i = 0; i < (int) sort_buf.size(); ++i )
65 sort_buf[i]->m_IntrinsicRank = i;
66 }
67}
68
69
70void LIB_TREE_NODE::SortNodes( bool aUseScores )
71{
72 std::sort( m_Children.begin(), m_Children.end(),
73 [&]( std::unique_ptr<LIB_TREE_NODE>& a, std::unique_ptr<LIB_TREE_NODE>& b )
74 {
75 return Compare( *a, *b, aUseScores );
76 } );
77
78 for( std::unique_ptr<LIB_TREE_NODE>& node: m_Children )
79 node->SortNodes( aUseScores );
80}
81
82
83bool LIB_TREE_NODE::Compare( LIB_TREE_NODE const& aNode1, LIB_TREE_NODE const& aNode2,
84 bool aUseScores )
85{
86 if( aNode1.m_Type != aNode2.m_Type )
87 return aNode1.m_Type < aNode2.m_Type;
88
89 // Recently used sorts at top
90 if( aNode1.m_Name.StartsWith( wxT( "-- " ) ) )
91 {
92 if( aNode2.m_Name.StartsWith( wxT( "-- " ) ) )
93 {
94 // Make sure -- Recently Used is always at the top
95 // Start by checking the name of aNode2, because we
96 // want to satisfy the irreflexive property of the
97 // strict weak ordering.
98 if( aNode2.m_Name.StartsWith( wxT( "-- Recently Used" ) ) )
99 return false;
100 else if( aNode1.m_Name.StartsWith( wxT( "-- Recently Used" ) ) )
101 return true;
102
103 return aNode1.m_IntrinsicRank > aNode2.m_IntrinsicRank;
104 }
105 else
106 {
107 return true;
108 }
109 }
110 else if( aNode2.m_Name.StartsWith( wxT( "-- " ) ) )
111 {
112 return false;
113 }
114
115 // Pinned nodes go next
116 if( aNode1.m_Pinned && !aNode2.m_Pinned )
117 return true;
118 else if( aNode2.m_Pinned && !aNode1.m_Pinned )
119 return false;
120
121 if( aUseScores && aNode1.m_Score != aNode2.m_Score )
122 return aNode1.m_Score > aNode2.m_Score;
123
124 if( aNode1.m_IntrinsicRank != aNode2.m_IntrinsicRank )
125 return aNode1.m_IntrinsicRank > aNode2.m_IntrinsicRank;
126
127 return reinterpret_cast<const void*>( &aNode1 ) < reinterpret_cast<const void*>( &aNode2 );
128}
129
130
132 : m_Parent( nullptr ),
133 m_Type( INVALID ),
134 m_IntrinsicRank( 0 ),
135 m_Score( 0 ),
136 m_Pinned( false ),
137 m_PinCount( 0 ),
138 m_Unit( 0 ),
139 m_IsRoot( false )
140{}
141
142
144{
145 static void* locale = nullptr;
146 static wxString namePrefix;
147
148 // Fetching translations can take a surprising amount of time when loading libraries,
149 // so only do it when necessary.
150 if( Pgm().GetLocale() != locale )
151 {
152 namePrefix = _( "Unit" );
153 locale = Pgm().GetLocale();
154 }
155
156 m_Parent = aParent;
157 m_Type = UNIT;
158
159 m_Unit = aUnit;
160 m_LibId = aParent->m_LibId;
161
162 m_Name = namePrefix + " " + aItem->GetUnitReference( aUnit );
163
164 if( aItem->HasUnitDisplayName( aUnit ) )
165 m_Desc = aItem->GetUnitDisplayName( aUnit );
166 else
167 m_Desc = wxEmptyString;
168
169 m_IntrinsicRank = -aUnit;
170}
171
172
173void LIB_TREE_NODE_UNIT::UpdateScore( EDA_COMBINED_MATCHER* aMatcher, const wxString& aLib,
174 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter )
175{
176 // aMatcher test results are inherited from parent
177 if( aMatcher )
179
180 // aFilter test is subtractive
181 if( aFilter && !(*aFilter)(*this) )
182 m_Score = 0;
183
184 // show all nodes if no search/filter/etc. criteria are given
185 if( !aMatcher && aLib.IsEmpty() && ( !aFilter || (*aFilter)(*this) ) )
186 m_Score = 1;
187}
188
189
191{
192 m_Type = ITEM;
193 m_Parent = aParent;
194
196 m_LibId.SetLibItemName( aItem->GetName() );
197
198 m_Name = aItem->GetName();
199 m_Desc = aItem->GetDesc();
200 m_Footprint = aItem->GetFootprint();
201 m_PinCount = aItem->GetPinCount();
202
203 aItem->GetChooserFields( m_Fields );
204
205 m_SearchTerms = aItem->GetSearchTerms();
206
207 m_IsRoot = aItem->IsRoot();
208
209 if( aItem->GetSubUnitCount() > 1 )
210 {
211 for( int u = 1; u <= aItem->GetSubUnitCount(); ++u )
212 AddUnit( aItem, u );
213 }
214}
215
216
218{
219 LIB_TREE_NODE_UNIT* unit = new LIB_TREE_NODE_UNIT( this, aItem, aUnit );
220 m_Children.push_back( std::unique_ptr<LIB_TREE_NODE>( unit ) );
221 return *unit;
222}
223
224
226{
228 m_LibId.SetLibItemName( aItem->GetName() );
229
230 m_Name = aItem->GetName();
231 m_Desc = aItem->GetDesc();
232
233 aItem->GetChooserFields( m_Fields );
234
235 m_SearchTerms = aItem->GetSearchTerms();
236
237 m_IsRoot = aItem->IsRoot();
238 m_Children.clear();
239
240 for( int u = 1; u <= aItem->GetSubUnitCount(); ++u )
241 AddUnit( aItem, u );
242}
243
244
245void LIB_TREE_NODE_ITEM::UpdateScore( EDA_COMBINED_MATCHER* aMatcher, const wxString& aLib,
246 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter )
247{
248 // aMatcher test is additive, but if we don't match the given term at all, it nulls out
249 if( aMatcher )
250 {
251 int currentScore = aMatcher->ScoreTerms( m_SearchTerms );
252
253 // This is a hack: the second phase of search in the adapter will look for a tokenized
254 // LIB_ID and send the lib part down here. While we generally want to prune ourselves
255 // out here (by setting score to -1) the first time we fail to match a search term,
256 // we want to give the same search term a second chance if it has been split from a library
257 // name.
258 if( ( m_Score >= 0 || !aLib.IsEmpty() ) && currentScore > 0 )
259 m_Score += currentScore;
260 else
261 m_Score = -1; // Item has failed to match this term, rule it out
262 }
263
264 // aFilter test is subtractive
265 if( aFilter && !(*aFilter)(*this) )
266 m_Score = 0;
267
268 // show all nodes if no search/filter/etc. criteria are given
269 if( !aMatcher && aLib.IsEmpty() && ( !aFilter || (*aFilter)(*this) ) )
270 m_Score = 1;
271
272 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
273 child->UpdateScore( aMatcher, aLib, aFilter );
274}
275
276
278 wxString const& aDesc )
279{
280 m_Type = LIBRARY;
281 m_Name = aName;
282 m_Desc = aDesc;
283 m_Parent = aParent;
284 m_LibId.SetLibNickname( aName );
285
286 m_SearchTerms.emplace_back( SEARCH_TERM( aName, 8 ) );
287}
288
289
291{
292 LIB_TREE_NODE_ITEM* item = new LIB_TREE_NODE_ITEM( this, aItem );
293 m_Children.push_back( std::unique_ptr<LIB_TREE_NODE>( item ) );
294 return *item;
295}
296
297
298void LIB_TREE_NODE_LIBRARY::UpdateScore( EDA_COMBINED_MATCHER* aMatcher, const wxString& aLib,
299 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter )
300{
301 int maxChildScore = 0;
302
303 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
304 {
305 child->UpdateScore( aMatcher, aLib, aFilter );
306 maxChildScore = std::max( maxChildScore, child->m_Score );
307 }
308
309 // Each time UpdateScore is called for a library, child (item) scores may go up or down.
310 // If the all go down to zero, we need to make sure to drop the library from the list.
311 if( maxChildScore > 0 )
312 m_Score = std::max( m_Score, maxChildScore );
313 else
314 m_Score = 0;
315
316 // aLib test is additive, but only when we've already accumulated some score from children
317 if( !aLib.IsEmpty()
318 && m_Name.Lower().Matches( aLib )
319 && ( m_Score > 0 || m_Children.empty() ) )
320 {
321 m_Score += 1;
322 }
323
324 // aMatcher test is additive
325 if( aMatcher )
326 {
327 int ownScore = aMatcher->ScoreTerms( m_SearchTerms );
328 m_Score += ownScore;
329
330 // If we have a hit on a library, show all children in that library
331 if( maxChildScore <= 0 && ownScore > 0 )
332 {
333 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
334 child->ForceScore( 1 );
335 }
336 }
337
338 // show all nodes if no search/filter/etc. criteria are given
339 if( m_Children.empty() && !aMatcher && aLib.IsEmpty() && ( !aFilter || (*aFilter)(*this) ) )
340 m_Score = 1;
341}
342
343
345{
346 m_Type = ROOT;
347}
348
349
350LIB_TREE_NODE_LIBRARY& LIB_TREE_NODE_ROOT::AddLib( wxString const& aName, wxString const& aDesc )
351{
352 LIB_TREE_NODE_LIBRARY* lib = new LIB_TREE_NODE_LIBRARY( this, aName, aDesc );
353 m_Children.push_back( std::unique_ptr<LIB_TREE_NODE>( lib ) );
354 return *lib;
355}
356
357
358void LIB_TREE_NODE_ROOT::UpdateScore( EDA_COMBINED_MATCHER* aMatcher, const wxString& aLib,
359 std::function<bool( LIB_TREE_NODE& aNode )>* aFilter )
360{
361 for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
362 child->UpdateScore( aMatcher, aLib, aFilter );
363}
364
int ScoreTerms(std::vector< SEARCH_TERM > &aWeightedTerms)
int SetLibItemName(const UTF8 &aLibItemName)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:110
int SetLibNickname(const UTF8 &aLibNickname)
Override the logical library name portion of the LIB_ID to aLibNickname.
Definition: lib_id.cpp:99
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 GetUnitReference(int aUnit)
For items with units, return an identifier for unit x.
Definition: lib_tree_item.h:84
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 std::vector< SEARCH_TERM > GetSearchTerms()
Definition: lib_tree_item.h:59
virtual bool HasUnitDisplayName(int aUnit)
For items with units, return true if a display name is set for x.
Definition: lib_tree_item.h:94
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 wxString GetUnitDisplayName(int aUnit)
For items with units, return a display name for unit x.
Definition: lib_tree_item.h:89
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(EDA_COMBINED_MATCHER *aMatcher, const wxString &aLib, 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 ...
LIB_TREE_NODE_ITEM & AddItem(LIB_TREE_ITEM *aItem)
Construct a new alias node, add it to this library, and return it.
void UpdateScore(EDA_COMBINED_MATCHER *aMatcher, const wxString &aLib, std::function< bool(LIB_TREE_NODE &aNode)> *aFilter) override
Update the score for this part.
LIB_TREE_NODE_LIBRARY & AddLib(wxString const &aName, wxString const &aDesc)
Construct an empty library node, add it to the root, and return it.
void UpdateScore(EDA_COMBINED_MATCHER *aMatcher, const wxString &aLib, std::function< bool(LIB_TREE_NODE &aNode)> *aFilter) override
Update the score for this part.
LIB_TREE_NODE_ROOT()
Construct the root node.
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(EDA_COMBINED_MATCHER *aMatcher, const wxString &aLib, 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).
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_SearchTerms
std::map< wxString, wxString > m_Fields
List of weighted search terms.
PTR_VECTOR m_Children
wxString m_Footprint
LIB_TREE_NODE * m_Parent
virtual void ResetScore()
Initialize scores recursively.
int m_IntrinsicRank
The rank of the item before any search terms are applied.
void AssignIntrinsicRanks(bool presorted=false)
Store intrinsic ranks on all children of this node.
virtual wxLocale * GetLocale()
Definition: pgm_base.h:185
#define _(s)
Abstract pattern-matching tool and implementations.
@ INVALID
Definition: kiface_ids.h:32
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1059
see class PGM_BASE