KiCad PCB EDA Suite
Loading...
Searching...
No Matches
lib_tree_model_adapter.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 <eda_base_frame.h>
24#include <eda_pattern_match.h>
25#include <kiface_base.h>
26#include <kiplatform/ui.h>
30#include <widgets/ui_common.h>
31#include <wx/tokenzr.h>
32#include <wx/wupdlock.h>
33#include <wx/settings.h>
34#include <wx/dc.h>
35#include <string_utils.h>
36
37
38static const int kDataViewIndent = 20;
39
40
41class LIB_TREE_RENDERER : public wxDataViewCustomRenderer
42{
43public:
45 m_canvasItem( false )
46 {}
47
48 wxSize GetSize() const override
49 {
50 return wxSize( GetOwner()->GetWidth(), GetTextExtent( m_text ).y + 2 );
51 }
52
53 bool GetValue( wxVariant& aValue ) const override
54 {
55 aValue = m_text;
56 return true;
57 }
58
59 bool SetValue( const wxVariant& aValue ) override
60 {
61 m_text = aValue.GetString();
62 return true;
63 }
64
65 void SetAttr( const wxDataViewItemAttr& aAttr ) override
66 {
67 // Use strikethrough as a proxy for is-canvas-item
68 m_canvasItem = aAttr.GetStrikethrough();
69
70 wxDataViewItemAttr realAttr = aAttr;
71 realAttr.SetStrikethrough( false );
72
73 wxDataViewCustomRenderer::SetAttr( realAttr );
74 }
75
76 bool Render( wxRect aRect, wxDC *dc, int aState ) override
77 {
78 RenderBackground( dc, aRect );
79
80 if( m_canvasItem )
81 {
82 wxPoint points[6];
83 points[0] = aRect.GetTopLeft();
84 points[1] = aRect.GetTopRight() + wxPoint( -4, 0 );
85 points[2] = aRect.GetTopRight() + wxPoint( 0, aRect.GetHeight() / 2 );
86 points[3] = aRect.GetBottomRight() + wxPoint( -4, 1 );
87 points[4] = aRect.GetBottomLeft() + wxPoint( 0, 1 );
88 points[5] = aRect.GetTopLeft();
89
90 dc->SetPen( KIPLATFORM::UI::IsDarkTheme() ? *wxWHITE_PEN : *wxBLACK_PEN );
91 dc->DrawLines( 6, points );
92 }
93
94 aRect.Deflate( 1 );
95
96#ifdef __WXOSX__
97 // We should be able to pass wxDATAVIEW_CELL_SELECTED into RenderText() and have it do
98 // the right thing -- but it picks wxSYS_COLOUR_HIGHLIGHTTEXT on MacOS (instead
99 // of wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT).
100 if( aState & wxDATAVIEW_CELL_SELECTED )
101 dc->SetTextForeground( wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT ) );
102
103 RenderText( m_text, 0, aRect, dc, 0 );
104#else
105 RenderText( m_text, 0, aRect, dc, aState );
106#endif
107 return true;
108 }
109
110private:
112 wxString m_text;
113};
114
115
116wxDataViewItem LIB_TREE_MODEL_ADAPTER::ToItem( const LIB_TREE_NODE* aNode )
117{
118 return wxDataViewItem( const_cast<void*>( static_cast<void const*>( aNode ) ) );
119}
120
121
123{
124 return static_cast<LIB_TREE_NODE*>( aItem.GetID() );
125}
126
127
129 const wxString& aPinnedKey ) :
130 m_widget( nullptr ),
131 m_parent( aParent ),
132 m_sort_mode( BEST_MATCH ),
133 m_show_units( true ),
134 m_preselect_unit( 0 ),
135 m_freeze( 0 ),
136 m_filter( nullptr )
137{
138 // Default column widths. Do not translate these names.
139 m_colWidths[ _HKI( "Item" ) ] = 300;
140 m_colWidths[ _HKI( "Description" ) ] = 600;
141
142 m_availableColumns = { _HKI( "Item" ), _HKI( "Description" ) };
143
145
146 for( const std::pair<const wxString, int>& pair : cfg->m_LibTree.column_widths )
147 m_colWidths[pair.first] = pair.second;
148
150
151 if( m_shownColumns.empty() )
152 m_shownColumns = { _HKI( "Item" ), _HKI( "Description" ) };
153
154 if( m_shownColumns[0] != _HKI( "Item" ) )
155 m_shownColumns.insert( m_shownColumns.begin(), _HKI( "Item" ) );
156}
157
158
160{}
161
162
163std::vector<wxString> LIB_TREE_MODEL_ADAPTER::GetOpenLibs() const
164{
165 std::vector<wxString> openLibs;
166 wxDataViewItem rootItem( nullptr );
167 wxDataViewItemArray children;
168
169 GetChildren( rootItem, children );
170
171 for( const wxDataViewItem& child : children )
172 {
173 if( m_widget->IsExpanded( child ) )
174 openLibs.emplace_back( ToNode( child )->m_LibId.GetLibNickname().wx_str() );
175 }
176
177 return openLibs;
178}
179
180
181void LIB_TREE_MODEL_ADAPTER::OpenLibs( const std::vector<wxString>& aLibs )
182{
183 wxWindowUpdateLocker updateLock( m_widget );
184
185 for( const wxString& lib : aLibs )
186 {
187 wxDataViewItem item = FindItem( LIB_ID( lib, wxEmptyString ) );
188
189 if( item.IsOk() )
190 m_widget->Expand( item );
191 }
192}
193
194
196{
197 if( m_widget )
198 {
200
202 cfg->m_LibTree.column_widths.clear();
203
204 for( const std::pair<const wxString, wxDataViewColumn*>& pair : m_colNameMap )
205 cfg->m_LibTree.column_widths[pair.first] = pair.second->GetWidth();
206
208 }
209}
210
211
213{
214 m_show_units = aShow;
215}
216
217
218void LIB_TREE_MODEL_ADAPTER::SetPreselectNode( const LIB_ID& aLibId, int aUnit )
219{
220 m_preselect_lib_id = aLibId;
221 m_preselect_unit = aUnit;
222}
223
224
226 const wxString& aDesc,
227 bool pinned )
228{
229 LIB_TREE_NODE_LIBRARY& lib_node = m_tree.AddLib( aNodeName, aDesc );
230
231 lib_node.m_Pinned = pinned;
232
233 return lib_node;
234}
235
236
237void LIB_TREE_MODEL_ADAPTER::DoAddLibrary( const wxString& aNodeName, const wxString& aDesc,
238 const std::vector<LIB_TREE_ITEM*>& aItemList,
239 bool pinned, bool presorted )
240{
241 LIB_TREE_NODE_LIBRARY& lib_node = DoAddLibraryNode( aNodeName, aDesc, pinned );
242
243 for( LIB_TREE_ITEM* item: aItemList )
244 lib_node.AddItem( item );
245
246 lib_node.AssignIntrinsicRanks( presorted );
247}
248
249
250void LIB_TREE_MODEL_ADAPTER::DoRemoveLibrary( const wxString& aNodeName )
251{
252 m_tree.RemoveLib( aNodeName );
253}
254
255
256void LIB_TREE_MODEL_ADAPTER::UpdateSearchString( const wxString& aSearch, bool aState )
257{
258 {
259 wxWindowUpdateLocker updateLock( m_widget );
260
261 // Even with the updateLock, wxWidgets sometimes ties its knickers in a knot trying to
262 // run a wxdataview_selection_changed_callback() on a row that has been deleted.
263 // https://bugs.launchpad.net/kicad/+bug/1756255
264 m_widget->UnselectAll();
265
266 // This collapse is required before the call to "Freeze()" below. Once Freeze()
267 // is called, GetParent() will return nullptr. While this works for some calls, it
268 // segfaults when we have any expanded elements b/c the sub units in the tree don't
269 // have explicit references that are maintained over a search
270 // The tree will be expanded again below when we get our matches
271 //
272 // Also note that this cannot happen when we have deleted a symbol as GTK will also
273 // iterate over the tree in this case and find a symbol that has an invalid link
274 // and crash https://gitlab.com/kicad/code/kicad/-/issues/6910
275 if( !aState && !aSearch.IsNull() && m_tree.m_Children.size() )
276 {
277 for( std::unique_ptr<LIB_TREE_NODE>& child: m_tree.m_Children )
278 m_widget->Collapse( wxDataViewItem( &*child ) );
279 }
280
281 // DO NOT REMOVE THE FREEZE/THAW. This freeze/thaw is a flag for this model adapter
282 // that tells it when it shouldn't trust any of the data in the model. When set, it will
283 // not return invalid data to the UI, since this invalid data can cause crashes.
284 // This is different than the update locker, which locks the UI aspects only.
285 Freeze();
286 BeforeReset();
287
289
290 wxStringTokenizer tokenizer( aSearch );
291 bool firstTerm = true;
292
293 while( tokenizer.HasMoreTokens() )
294 {
295 // First search for the full token, in case it appears in a search string
296 wxString term = tokenizer.GetNextToken().Lower();
297 EDA_COMBINED_MATCHER termMatcher( term, CTX_LIBITEM );
298
299 m_tree.UpdateScore( &termMatcher, wxEmptyString, m_filter );
300 firstTerm = false;
301
302 if( term.Contains( ":" ) )
303 {
304 // Next search for the library:item_name
305 wxString lib = term.BeforeFirst( ':' );
306 wxString itemName = term.AfterFirst( ':' );
307 EDA_COMBINED_MATCHER itemNameMatcher( itemName, CTX_LIBITEM );
308
309 m_tree.UpdateScore( &itemNameMatcher, lib, m_filter );
310 }
311 }
312
313 if( firstTerm )
314 {
315 // No terms processed; just run the filter
316 m_tree.UpdateScore( nullptr, wxEmptyString, m_filter );
317 }
318
320 AfterReset();
321 Thaw();
322 }
323
324 const LIB_TREE_NODE* firstMatch = ShowResults();
325
326 if( firstMatch )
327 {
328 wxDataViewItem item = ToItem( firstMatch );
329 m_widget->Select( item );
330
331 // Make sure the *parent* item is visible. The selected item is the first (shown) child
332 // of the parent. So it's always right below the parent, and this way the user can also
333 // see what library the selected part belongs to, without having a case where the selection
334 // is off the screen (unless the window is a single row high, which is unlikely).
335 //
336 // This also happens to circumvent https://bugs.launchpad.net/kicad/+bug/1804400 which
337 // appears to be a GTK+3 bug.
338 {
339 wxDataViewItem parent = GetParent( item );
340
341 if( parent.IsOk() )
342 m_widget->EnsureVisible( parent );
343 }
344
345 m_widget->EnsureVisible( item );
346 }
347}
348
349
350void LIB_TREE_MODEL_ADAPTER::AttachTo( wxDataViewCtrl* aDataViewCtrl )
351{
352 m_widget = aDataViewCtrl;
353 aDataViewCtrl->SetIndent( kDataViewIndent );
354 aDataViewCtrl->AssociateModel( this );
356}
357
358
360{
361 m_widget->ClearColumns();
362
363 m_columns.clear();
364 m_colIdxMap.clear();
365 m_colNameMap.clear();
366
367 // The Item column is always shown
368 doAddColumn( wxT( "Item" ) );
369
370 for( const wxString& colName : m_shownColumns )
371 {
372 if( !m_colNameMap.count( colName ) )
373 doAddColumn( colName, colName == wxT( "Description" ) );
374 }
375}
376
377
379{
380 Freeze();
381 BeforeReset();
382
384
385 AfterReset();
386 Thaw();
387}
388
389
391{
393 aTreeNode->m_Pinned = true;
394
395 resortTree();
396 m_widget->EnsureVisible( ToItem( aTreeNode ) );
397}
398
399
401{
403 aTreeNode->m_Pinned = false;
404
405 resortTree();
406 // Keep focus at top when unpinning
407}
408
409
410wxDataViewColumn* LIB_TREE_MODEL_ADAPTER::doAddColumn( const wxString& aHeader, bool aTranslate )
411{
412 wxString translatedHeader = aTranslate ? wxGetTranslation( aHeader ) : aHeader;
413
414 // The extent of the text doesn't take into account the space on either side
415 // in the header, so artificially pad it
416 wxSize headerMinWidth = KIUI::GetTextSize( translatedHeader + wxT( "MMM" ), m_widget );
417
418 if( !m_colWidths.count( aHeader ) || m_colWidths[aHeader] < headerMinWidth.x )
419 m_colWidths[aHeader] = headerMinWidth.x;
420
421 int index = (int) m_columns.size();
422
423 wxDataViewColumn* col = new wxDataViewColumn(
424 translatedHeader, new LIB_TREE_RENDERER(), index, m_colWidths[aHeader], wxALIGN_NOT,
425 wxDATAVIEW_CELL_INERT | static_cast<int>( wxDATAVIEW_COL_RESIZABLE ) );
426 m_widget->AppendColumn( col );
427
428 col->SetMinWidth( headerMinWidth.x );
429
430 m_columns.emplace_back( col );
431 m_colNameMap[aHeader] = col;
432 m_colIdxMap[m_columns.size() - 1] = aHeader;
433
434 return col;
435}
436
437
438void LIB_TREE_MODEL_ADAPTER::addColumnIfNecessary( const wxString& aHeader )
439{
440 if( m_colNameMap.count( aHeader ) )
441 return;
442
443 // Columns will be created later
444 m_colNameMap[aHeader] = nullptr;
445 m_availableColumns.emplace_back( aHeader );
446}
447
448
449void LIB_TREE_MODEL_ADAPTER::SetShownColumns( const std::vector<wxString>& aColumnNames )
450{
451 bool recreate = m_shownColumns != aColumnNames;
452
453 m_shownColumns = aColumnNames;
454
455 if( recreate && m_widget )
457}
458
459
460LIB_ID LIB_TREE_MODEL_ADAPTER::GetAliasFor( const wxDataViewItem& aSelection ) const
461{
462 const LIB_TREE_NODE* node = ToNode( aSelection );
463 return node ? node->m_LibId : LIB_ID();
464}
465
466
467int LIB_TREE_MODEL_ADAPTER::GetUnitFor( const wxDataViewItem& aSelection ) const
468{
469 const LIB_TREE_NODE* node = ToNode( aSelection );
470 return node ? node->m_Unit : 0;
471}
472
473
474LIB_TREE_NODE::TYPE LIB_TREE_MODEL_ADAPTER::GetTypeFor( const wxDataViewItem& aSelection ) const
475{
476 const LIB_TREE_NODE* node = ToNode( aSelection );
477 return node ? node->m_Type : LIB_TREE_NODE::TYPE::INVALID;
478}
479
480
481LIB_TREE_NODE* LIB_TREE_MODEL_ADAPTER::GetTreeNodeFor( const wxDataViewItem& aSelection ) const
482{
483 return ToNode( aSelection );
484}
485
486
488{
489 int n = 0;
490
491 for( const std::unique_ptr<LIB_TREE_NODE>& lib: m_tree.m_Children )
492 n += lib->m_Children.size();
493
494 return n;
495}
496
497
498wxDataViewItem LIB_TREE_MODEL_ADAPTER::FindItem( const LIB_ID& aLibId )
499{
500 for( std::unique_ptr<LIB_TREE_NODE>& lib: m_tree.m_Children )
501 {
502 if( lib->m_Name != aLibId.GetLibNickname().wx_str() )
503 continue;
504
505 // if part name is not specified, return the library node
506 if( aLibId.GetLibItemName() == "" )
507 return ToItem( lib.get() );
508
509 for( std::unique_ptr<LIB_TREE_NODE>& alias: lib->m_Children )
510 {
511 if( alias->m_Name == aLibId.GetLibItemName().wx_str() )
512 return ToItem( alias.get() );
513 }
514
515 break; // could not find the part in the requested library
516 }
517
518 return wxDataViewItem();
519}
520
521
523{
525}
526
527
528unsigned int LIB_TREE_MODEL_ADAPTER::GetChildren( const wxDataViewItem& aItem,
529 wxDataViewItemArray& aChildren ) const
530{
531 const LIB_TREE_NODE* node = ( aItem.IsOk() ? ToNode( aItem ) : &m_tree );
532 unsigned int count = 0;
533
534 if( node->m_Type == LIB_TREE_NODE::TYPE::ROOT
535 || node->m_Type == LIB_TREE_NODE::TYPE::LIBRARY
536 || ( m_show_units && node->m_Type == LIB_TREE_NODE::TYPE::ITEM ) )
537 {
538 for( std::unique_ptr<LIB_TREE_NODE> const& child: node->m_Children )
539 {
540 if( child->m_Score > 0 )
541 {
542 aChildren.Add( ToItem( &*child ) );
543 ++count;
544 }
545 }
546 }
547
548 return count;
549}
550
551
553{
554 wxDataViewColumn* col = nullptr;
555 size_t idx = 0;
556 int totalWidth = 0;
557 wxString header;
558
559 for( ; idx < m_columns.size() - 1; idx++ )
560 {
561 wxASSERT( m_colIdxMap.count( idx ) );
562
563 col = m_columns[idx];
564 header = m_colIdxMap[idx];
565
566 wxASSERT( m_colWidths.count( header ) );
567
568 col->SetWidth( m_colWidths[header] );
569 totalWidth += col->GetWidth();
570 }
571
572 int remainingWidth = m_widget->GetSize().x - totalWidth;
573 header = m_columns[idx]->GetTitle();
574
575 m_columns[idx]->SetWidth( std::max( m_colWidths[header], remainingWidth ) );
576}
577
578
580{
581 // Yes, this is an enormous hack. But it works on all platforms, it doesn't suffer
582 // the On^2 sorting issues that ItemChanged() does on OSX, and it doesn't lose the
583 // user's scroll position (which re-attaching or deleting/re-inserting columns does).
584 static int walk = 1;
585
586 std::vector<int> widths;
587
588 for( const wxDataViewColumn* col : m_columns )
589 widths.emplace_back( col->GetWidth() );
590
591 wxASSERT( widths.size() );
592
593 // Only use the widths read back if they are non-zero.
594 // GTK returns the displayed width of the column, which is not calculated immediately
595 if( widths[0] > 0 )
596 {
597 size_t i = 0;
598
599 for( const auto& [ colName, colPtr ] : m_colNameMap )
600 m_colWidths[ colName ] = widths[i++];
601 }
602
603 auto colIt = m_colWidths.begin();
604
605 colIt->second += walk;
606 colIt++;
607
608 if( colIt != m_colWidths.end() )
609 colIt->second -= walk;
610
611 for( const auto& [ colName, colPtr ] : m_colNameMap )
612 {
613 if( colPtr == m_columns[0] )
614 continue;
615
616 wxASSERT( m_colWidths.count( colName ) );
617 colPtr->SetWidth( m_colWidths[ colName ] );
618 }
619
620 walk = -walk;
621}
622
623
624bool LIB_TREE_MODEL_ADAPTER::HasContainerColumns( const wxDataViewItem& aItem ) const
625{
626 return IsContainer( aItem );
627}
628
629
630bool LIB_TREE_MODEL_ADAPTER::IsContainer( const wxDataViewItem& aItem ) const
631{
632 LIB_TREE_NODE* node = ToNode( aItem );
633 return node ? node->m_Children.size() : true;
634}
635
636
637wxDataViewItem LIB_TREE_MODEL_ADAPTER::GetParent( const wxDataViewItem& aItem ) const
638{
639 if( m_freeze )
640 return ToItem( nullptr );
641
642 LIB_TREE_NODE* node = ToNode( aItem );
643 LIB_TREE_NODE* parent = node ? node->m_Parent : nullptr;
644
645 // wxDataViewModel has no root node, but rather top-level elements have
646 // an invalid (null) parent.
647 if( !node || !parent || parent->m_Type == LIB_TREE_NODE::TYPE::ROOT )
648 return ToItem( nullptr );
649 else
650 return ToItem( parent );
651}
652
653
654void LIB_TREE_MODEL_ADAPTER::GetValue( wxVariant& aVariant,
655 const wxDataViewItem& aItem,
656 unsigned int aCol ) const
657{
658 if( IsFrozen() )
659 {
660 aVariant = wxEmptyString;
661 return;
662 }
663
664 LIB_TREE_NODE* node = ToNode( aItem );
665 wxCHECK( node, /* void */ );
666 wxString valueStr;
667
668 switch( aCol )
669 {
670 case NAME_COL:
671 if( node->m_Pinned )
672 valueStr = GetPinningSymbol() + UnescapeString( node->m_Name );
673 else
674 valueStr = UnescapeString( node->m_Name );
675
676 break;
677
678 default:
679 if( m_colIdxMap.count( aCol ) )
680 {
681 const wxString& key = m_colIdxMap.at( aCol );
682
683 if( key == wxT( "Description" ) )
684 valueStr = UnescapeString( node->m_Desc );
685 else if( node->m_Fields.count( key ) )
686 valueStr = UnescapeString( node->m_Fields.at( key ) );
687 else
688 valueStr = wxEmptyString;
689 }
690
691 break;
692 }
693
694 valueStr.Replace( wxS( "\n" ), wxS( " " ) ); // Clear line breaks
695
696 aVariant = valueStr;
697}
698
699
700bool LIB_TREE_MODEL_ADAPTER::GetAttr( const wxDataViewItem& aItem,
701 unsigned int aCol,
702 wxDataViewItemAttr& aAttr ) const
703{
704 if( IsFrozen() )
705 return false;
706
707 LIB_TREE_NODE* node = ToNode( aItem );
708 wxCHECK( node, false );
709
710 if( node->m_Type == LIB_TREE_NODE::TYPE::ITEM )
711 {
712 if( !node->m_IsRoot && aCol == 0 )
713 {
714 // Names of non-root aliases are italicized
715 aAttr.SetItalic( true );
716 return true;
717 }
718 }
719
720 return false;
721}
722
723
724void recursiveDescent( LIB_TREE_NODE& aNode, const std::function<int( const LIB_TREE_NODE* )>& f )
725{
726 for( std::unique_ptr<LIB_TREE_NODE>& node: aNode.m_Children )
727 {
728 int r = f( node.get() );
729
730 if( r == 0 )
731 break;
732 else if( r == -1 )
733 continue;
734
735 recursiveDescent( *node, f );
736 }
737}
738
739
741{
742 const LIB_TREE_NODE* firstMatch = nullptr;
743
744 // Expand parents of leaf nodes with some level of matching
746 [&]( const LIB_TREE_NODE* n )
747 {
748 if( n->m_Type == LIB_TREE_NODE::TYPE::ITEM && n->m_Score > 1 )
749 {
750 if( !firstMatch )
751 firstMatch = n;
752 else if( n->m_Score > firstMatch->m_Score )
753 firstMatch = n;
754
755 m_widget->ExpandAncestors( ToItem( n ) );
756 }
757
758 return 1; // keep going to expand ancestors of all found items
759 } );
760
761 // If no matches, find and show the preselect node
762 if( !firstMatch && m_preselect_lib_id.IsValid() )
763 {
765 [&]( const LIB_TREE_NODE* n )
766 {
767 // Don't match the recent and already placed libraries
768 if( n->m_Name.StartsWith( "-- " ) )
769 return -1; // Skip this node and its children
770
771 if( n->m_Type == LIB_TREE_NODE::TYPE::ITEM
772 && ( n->m_Children.empty() || !m_preselect_unit )
773 && m_preselect_lib_id == n->m_LibId )
774 {
775 firstMatch = n;
776 m_widget->ExpandAncestors( ToItem( n ) );
777 return 0;
778 }
779 else if( n->m_Type == LIB_TREE_NODE::TYPE::UNIT
782 {
783 firstMatch = n;
784 m_widget->ExpandAncestors( ToItem( n ) );
785 return 0;
786 }
787
788 return 1;
789 } );
790 }
791
792 // If still no matches expand a single library if there is only one
793 if( !firstMatch )
794 {
795 int libraries = 0;
796
797 for( const std::unique_ptr<LIB_TREE_NODE>& child : m_tree.m_Children )
798 {
799 if( !child->m_Name.StartsWith( "-- " ) )
800 libraries++;
801 }
802
803 if( libraries != 1 )
804 return nullptr;
805
807 [&]( const LIB_TREE_NODE* n )
808 {
809 if( n->m_Type == LIB_TREE_NODE::TYPE::ITEM )
810 {
811 firstMatch = n;
812 m_widget->ExpandAncestors( ToItem( n ) );
813 return 0;
814 }
815
816 return 1;
817 } );
818 }
819
820 return firstMatch;
821}
822
823
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
The base frame for deriving all KiCad main window classes.
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:95
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:172
const UTF8 & GetLibItemName() const
Definition: lib_id.h:102
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
std::vector< wxString > GetOpenLibs() const
int GetUnitFor(const wxDataViewItem &aSelection) const
Return the unit for the given item.
LIB_TREE_NODE::TYPE GetTypeFor(const wxDataViewItem &aSelection) const
Return node type for the given item.
bool GetAttr(const wxDataViewItem &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
Get any formatting for an item.
std::map< wxString, int > m_colWidths
void FinishTreeInitialization()
A final-stage initialization to be called after the window hierarchy has been realized and the window...
void addColumnIfNecessary(const wxString &aHeader)
void PinLibrary(LIB_TREE_NODE *aTreeNode)
virtual PROJECT::LIB_TYPE_T getLibType()=0
virtual wxDataViewItem GetCurrentDataViewItem()
void SetPreselectNode(const LIB_ID &aLibId, int aUnit)
Set the symbol name to be selected if there are no search results.
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
LIB_ID GetAliasFor(const wxDataViewItem &aSelection) const
Return the alias for the given item.
void AttachTo(wxDataViewCtrl *aDataViewCtrl)
Attach to a wxDataViewCtrl and initialize it.
void DoAddLibrary(const wxString &aNodeName, const wxString &aDesc, const std::vector< LIB_TREE_ITEM * > &aItemList, bool pinned, bool presorted)
Add the given list of symbols by alias.
void SetShownColumns(const std::vector< wxString > &aColumnNames)
Sets which columns are shown in the widget.
static wxDataViewItem ToItem(const LIB_TREE_NODE *aNode)
Convert #SYM_TREE_NODE -> wxDataViewItem.
bool IsContainer(const wxDataViewItem &aItem) const override
Check whether an item can have children.
static const wxString GetPinningSymbol()
void ShowUnits(bool aShow)
Whether or not to show units.
LIB_TREE_NODE * GetTreeNodeFor(const wxDataViewItem &aSelection) const
unsigned int GetChildren(const wxDataViewItem &aItem, wxDataViewItemArray &aChildren) const override
Populate a list of all the children of an item.
void SaveSettings()
Save the column widths to the config file.
@ NAME_COL
Library or library item name column.
std::map< unsigned, wxString > m_colIdxMap
wxDataViewColumn * doAddColumn(const wxString &aHeader, bool aTranslate=true)
LIB_TREE_MODEL_ADAPTER(EDA_BASE_FRAME *aParent, const wxString &aPinnedKey)
Create the adapter.
std::vector< wxDataViewColumn * > m_columns
std::vector< wxString > GetShownColumns() const
int GetItemCount() const
Return the number of symbols loaded in the tree.
const LIB_TREE_NODE * ShowResults()
Find and expand successful search results.
std::vector< wxString > m_shownColumns
void GetValue(wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) const override
Get the value of an item.
void UnpinLibrary(LIB_TREE_NODE *aTreeNode)
void DoRemoveLibrary(const wxString &aNodeName)
Remove the library by name.
std::map< wxString, wxDataViewColumn * > m_colNameMap
bool HasContainerColumns(const wxDataViewItem &aItem) const override
Check whether a container has columns too.
wxDataViewItem GetParent(const wxDataViewItem &aItem) const override
Get the parent of an item.
LIB_TREE_NODE_LIBRARY & DoAddLibraryNode(const wxString &aNodeName, const wxString &aDesc, bool pinned)
std::vector< wxString > m_availableColumns
wxDataViewItem FindItem(const LIB_ID &aLibId)
Returns tree item corresponding to part.
void UpdateSearchString(const wxString &aSearch, bool aState)
Set the search string provided by the user.
std::function< bool(LIB_TREE_NODE &aNode)> * m_filter
void OpenLibs(const std::vector< wxString > &aLibs)
Node type: library.
LIB_TREE_NODE_ITEM & AddItem(LIB_TREE_ITEM *aItem)
Construct a new alias node, add it to this library, and return it.
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 RemoveLib(wxString const &aName)
Remove a library node from the root.
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).
enum TYPE m_Type
std::map< wxString, wxString > m_Fields
List of weighted search terms.
PTR_VECTOR m_Children
LIB_TREE_NODE * m_Parent
virtual void ResetScore()
Initialize scores recursively.
void AssignIntrinsicRanks(bool presorted=false)
Store intrinsic ranks on all children of this node.
void SetAttr(const wxDataViewItemAttr &aAttr) override
bool SetValue(const wxVariant &aValue) override
wxSize GetSize() const override
bool GetValue(wxVariant &aValue) const override
bool Render(wxRect aRect, wxDC *dc, int aState) override
void PinLibrary(const wxString &aLibrary, enum LIB_TYPE_T aLibType)
Definition: project.cpp:177
void UnpinLibrary(const wxString &aLibrary, enum LIB_TYPE_T aLibType)
Definition: project.cpp:214
wxString wx_str() const
Definition: utf8.cpp:45
#define _HKI(x)
static void recursiveDescent(wxSizer *aSizer, std::map< int, wxString > &aLabels)
Base window classes and related definitions.
Abstract pattern-matching tool and implementations.
@ CTX_LIBITEM
void recursiveDescent(LIB_TREE_NODE &aNode, const std::function< int(const LIB_TREE_NODE *)> &f)
static const int kDataViewIndent
bool IsDarkTheme()
Determine if the desktop interface is currently using a dark theme or a light theme.
Definition: wxgtk/ui.cpp:48
KICOMMON_API wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
Definition: ui_common.cpp:77
wxString UnescapeString(const wxString &aSource)
std::vector< wxString > columns
Ordered list of visible columns in the tree.
Definition: app_settings.h:121
std::map< wxString, int > column_widths
Column widths, keyed by header name.
Definition: app_settings.h:122
std::vector< wxString > open_libs
list of libraries the user has open in the tree
Definition: app_settings.h:123
Functions to provide common constants and other functions to assist in making a consistent UI.