KiCad PCB EDA Suite
FP_TREE_MODEL_ADAPTER Class Reference

#include <fp_tree_model_adapter.h>

Inheritance diagram for FP_TREE_MODEL_ADAPTER:
LIB_TREE_MODEL_ADAPTER FP_TREE_SYNCHRONIZING_ADAPTER

Public Types

enum  SYM_FILTER_TYPE { SYM_FILTER_NONE, SYM_FILTER_POWER }
 This enum allows a selective filtering of symbols to list. More...
 
enum  TREE_COLS { PART_COL = 0, DESC_COL, NUM_COLS }
 This enum defines the order of the columns in the tree view. More...
 

Public Member Functions

void AddLibraries ()
 
wxString GenerateInfo (LIB_ID const &aLibId, int aUnit) override
 
void SaveColWidths ()
 Save the column widths to the config file. More...
 
void SavePinnedItems ()
 
void SetFilter (SYM_FILTER_TYPE aFilter)
 Set the symbol filter type. More...
 
SYM_FILTER_TYPE GetFilter () const
 Return the active filter. More...
 
void ShowUnits (bool aShow)
 Whether or not to show units. More...
 
void SetPreselectNode (const LIB_ID &aLibId, int aUnit)
 Set the symbol name to be selected if there are no search results. More...
 
void DoAddLibrary (const wxString &aNodeName, const wxString &aDesc, const std::vector< LIB_TREE_ITEM * > &aItemList, bool presorted)
 Add the given list of symbols by alias. More...
 
void AssignIntrinsicRanks ()
 Sort the tree and assign ranks after adding libraries. More...
 
void UpdateSearchString (const wxString &aSearch, bool aState)
 Set the search string provided by the user. More...
 
void AttachTo (wxDataViewCtrl *aDataViewCtrl)
 Attach to a wxDataViewCtrl and initialize it. More...
 
void FinishTreeInitialization ()
 A final-stage initialization to be called after the window hierarchy has been realized and the window sizes set. More...
 
LIB_ID GetAliasFor (const wxDataViewItem &aSelection) const
 Return the alias for the given item. More...
 
int GetUnitFor (const wxDataViewItem &aSelection) const
 Return the unit for the given item. More...
 
LIB_TREE_NODE::TYPE GetTypeFor (const wxDataViewItem &aSelection) const
 Return node type for the given item. More...
 
LIB_TREE_NODEGetTreeNodeFor (const wxDataViewItem &aSelection) const
 
int GetItemCount () const
 Return the number of symbols loaded in the tree. More...
 
virtual int GetLibrariesCount () const
 Return the number of libraries loaded in the tree. More...
 
wxDataViewItem FindItem (const LIB_ID &aLibId)
 Returns tree item corresponding to part. More...
 
unsigned int GetChildren (const wxDataViewItem &aItem, wxDataViewItemArray &aChildren) const override
 Populate a list of all the children of an item. More...
 
void Freeze ()
 
void Thaw ()
 
bool IsFrozen () const
 
void RefreshTree ()
 
virtual TOOL_INTERACTIVEGetContextMenuTool ()
 

Static Public Member Functions

static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTERCreate (EDA_BASE_FRAME *aParent, LIB_TABLE *aLibs)
 Factory function: create a model adapter in a reference-counting container. More...
 

Protected Member Functions

 FP_TREE_MODEL_ADAPTER (EDA_BASE_FRAME *aParent, LIB_TABLE *aLibs)
 Constructor; takes a set of libraries to be included in the search. More...
 
std::vector< LIB_TREE_ITEM * > getFootprints (const wxString &aLibName)
 
LIB_TREE_NODE_LIBDoAddLibraryNode (const wxString &aNodeName, const wxString &aDesc)
 
bool HasContainerColumns (const wxDataViewItem &aItem) const override
 Check whether a container has columns too. More...
 
bool IsContainer (const wxDataViewItem &aItem) const override
 Check whether an item can have children. More...
 
wxDataViewItem GetParent (const wxDataViewItem &aItem) const override
 Get the parent of an item. More...
 
unsigned int GetColumnCount () const override
 
wxString GetColumnType (unsigned int aCol) const override
 Return the type of data stored in the column as indicated by wxVariant::GetType() More...
 
void GetValue (wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) const override
 Get the value of an item. More...
 
bool SetValue (const wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) override
 Set the value of an item. More...
 
bool GetAttr (const wxDataViewItem &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
 Get any formatting for an item. More...
 
const wxString GetPinningSymbol () const
 

Static Protected Member Functions

static wxDataViewItem ToItem (const LIB_TREE_NODE *aNode)
 Convert #SYM_TREE_NODE -> wxDataViewItem. More...
 
static LIB_TREE_NODEToNode (wxDataViewItem aItem)
 Convert wxDataViewItem -> #SYM_TREE_NODE. More...
 
static unsigned int IntoArray (const LIB_TREE_NODE &aNode, wxDataViewItemArray &aChildren)
 Convert SYM_TREE_NODE's children to wxDataViewItemArray. More...
 

Protected Attributes

FP_LIB_TABLEm_libs
 
LIB_TREE_NODE_ROOT m_tree
 

Detailed Description

Definition at line 31 of file fp_tree_model_adapter.h.

Member Enumeration Documentation

◆ SYM_FILTER_TYPE

This enum allows a selective filtering of symbols to list.

Enumerator
SYM_FILTER_NONE 

no filtering

SYM_FILTER_POWER 

list symbols flagged PWR

Definition at line 109 of file lib_tree_model_adapter.h.

◆ TREE_COLS

This enum defines the order of the columns in the tree view.

Enumerator
PART_COL 

Part name column.

DESC_COL 

Part description column.

NUM_COLS 

The number of tree columns.

Definition at line 118 of file lib_tree_model_adapter.h.

119  {
120  PART_COL = 0,
121  DESC_COL,
122  NUM_COLS
123  };

Constructor & Destructor Documentation

◆ FP_TREE_MODEL_ADAPTER()

FP_TREE_MODEL_ADAPTER::FP_TREE_MODEL_ADAPTER ( EDA_BASE_FRAME aParent,
LIB_TABLE aLibs 
)
protected

Constructor; takes a set of libraries to be included in the search.

Definition at line 39 of file fp_tree_model_adapter.cpp.

39  :
40  LIB_TREE_MODEL_ADAPTER( aParent, "pinned_footprint_libs" ),
41  m_libs( (FP_LIB_TABLE*) aLibs )
42 {}
LIB_TREE_MODEL_ADAPTER(EDA_BASE_FRAME *aParent, const wxString &aPinnedKey)
Create the adapter.

Referenced by Create().

Member Function Documentation

◆ AddLibraries()

void FP_TREE_MODEL_ADAPTER::AddLibraries ( )

Definition at line 45 of file fp_tree_model_adapter.cpp.

46 {
47  for( const wxString& libName : m_libs->GetLogicalLibs() )
48  {
49  const FP_LIB_TABLE_ROW* library = m_libs->FindRow( libName, true );
50 
51  DoAddLibrary( libName, library->GetDescr(), getFootprints( libName ), true );
52  }
53 
55 }
Hold a record identifying a library accessed by the appropriate footprint library PLUGIN object in th...
Definition: fp_lib_table.h:40
std::vector< LIB_TREE_ITEM * > getFootprints(const wxString &aLibName)
void DoAddLibrary(const wxString &aNodeName, const wxString &aDesc, const std::vector< LIB_TREE_ITEM * > &aItemList, bool presorted)
Add the given list of symbols by alias.
void AssignIntrinsicRanks(bool presorted=false)
Store intrinsic ranks on all children of this node.
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an FP_LIB_TABLE_ROW if aNickName is found in this table or in any chained fall back table frag...
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

References LIB_TREE_NODE::AssignIntrinsicRanks(), LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), FP_LIB_TABLE::FindRow(), getFootprints(), LIB_TABLE::GetLogicalLibs(), library, m_libs, and LIB_TREE_MODEL_ADAPTER::m_tree.

Referenced by PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ AssignIntrinsicRanks()

void LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks ( )
inlineinherited

Sort the tree and assign ranks after adding libraries.

Definition at line 176 of file lib_tree_model_adapter.h.

void AssignIntrinsicRanks(bool presorted=false)
Store intrinsic ranks on all children of this node.

References LIB_TREE_NODE::AssignIntrinsicRanks(), and LIB_TREE_MODEL_ADAPTER::m_tree.

◆ AttachTo()

void LIB_TREE_MODEL_ADAPTER::AttachTo ( wxDataViewCtrl *  aDataViewCtrl)
inherited

Attach to a wxDataViewCtrl and initialize it.

This will set up columns and associate the model via the adapter.

Parameters
aDataViewCtrlthe view symbol in the dialog

Definition at line 271 of file lib_tree_model_adapter.cpp.

272 {
273  wxString partHead = _( "Item" );
274  wxString descHead = _( "Description" );
275 
276  // The extent of the text doesn't take into account the space on either side
277  // in the header, so artificially pad it
278  wxSize partHeadMinWidth = KIUI::GetTextSize( partHead + "MMM", aDataViewCtrl );
279 
280  // Ensure the part column is wider than the smallest allowable width
281  if( m_colWidths[PART_COL] < partHeadMinWidth.x )
282  m_colWidths[PART_COL] = partHeadMinWidth.x;
283 
284  m_widget = aDataViewCtrl;
285  aDataViewCtrl->SetIndent( kDataViewIndent );
286  aDataViewCtrl->AssociateModel( this );
287  aDataViewCtrl->ClearColumns();
288 
289  m_col_part = aDataViewCtrl->AppendTextColumn( partHead, PART_COL, wxDATAVIEW_CELL_INERT,
291  m_col_desc = aDataViewCtrl->AppendTextColumn( descHead, DESC_COL, wxDATAVIEW_CELL_INERT,
293 
294  m_col_part->SetMinWidth( partHeadMinWidth.x );
295 }
static const int kDataViewIndent
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:70
#define _(s)

References _, LIB_TREE_MODEL_ADAPTER::DESC_COL, KIUI::GetTextSize(), kDataViewIndent, LIB_TREE_MODEL_ADAPTER::m_col_desc, LIB_TREE_MODEL_ADAPTER::m_col_part, LIB_TREE_MODEL_ADAPTER::m_colWidths, LIB_TREE_MODEL_ADAPTER::m_widget, and LIB_TREE_MODEL_ADAPTER::PART_COL.

◆ Create()

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > FP_TREE_MODEL_ADAPTER::Create ( EDA_BASE_FRAME aParent,
LIB_TABLE aLibs 
)
static

Factory function: create a model adapter in a reference-counting container.

Parameters
aLibslibrary set from which parts will be loaded

Definition at line 32 of file fp_tree_model_adapter.cpp.

33 {
34  auto* adapter = new FP_TREE_MODEL_ADAPTER( aParent, aLibs );
35  return wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>( adapter );
36 }
FP_TREE_MODEL_ADAPTER(EDA_BASE_FRAME *aParent, LIB_TABLE *aLibs)
Constructor; takes a set of libraries to be included in the search.

References FP_TREE_MODEL_ADAPTER().

Referenced by PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ DoAddLibrary()

void LIB_TREE_MODEL_ADAPTER::DoAddLibrary ( const wxString &  aNodeName,
const wxString &  aDesc,
const std::vector< LIB_TREE_ITEM * > &  aItemList,
bool  presorted 
)
inherited

Add the given list of symbols by alias.

To be called in the setup phase.

Parameters
aNodeNamethe parent node the symbols will appear under
aDescthe description field of the parent node
aItemListlist of symbols

Definition at line 170 of file lib_tree_model_adapter.cpp.

173 {
174  LIB_TREE_NODE_LIB& lib_node = DoAddLibraryNode( aNodeName, aDesc );
175 
176  for( LIB_TREE_ITEM* item: aItemList )
177  lib_node.AddItem( item );
178 
179  lib_node.AssignIntrinsicRanks( presorted );
180 }
LIB_TREE_NODE_LIB & DoAddLibraryNode(const wxString &aNodeName, const wxString &aDesc)
A mix-in to provide polymorphism between items stored in libraries (symbols, aliases and footprints).
Definition: lib_tree_item.h:38
LIB_TREE_NODE_LIB_ID & AddItem(LIB_TREE_ITEM *aItem)
Construct a new alias node, add it to this library, and return it.
Node type: library.
void AssignIntrinsicRanks(bool presorted=false)
Store intrinsic ranks on all children of this node.

References LIB_TREE_NODE_LIB::AddItem(), LIB_TREE_NODE::AssignIntrinsicRanks(), and LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode().

Referenced by AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ DoAddLibraryNode()

LIB_TREE_NODE_LIB & LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode ( const wxString &  aNodeName,
const wxString &  aDesc 
)
protectedinherited

Definition at line 159 of file lib_tree_model_adapter.cpp.

161 {
162  LIB_TREE_NODE_LIB& lib_node = m_tree.AddLib( aNodeName, aDesc );
163 
164  lib_node.m_Pinned = m_pinnedLibs.Index( lib_node.m_LibId.GetLibNickname() ) != wxNOT_FOUND;
165 
166  return lib_node;
167 }
Node type: library.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:90
LIB_TREE_NODE_LIB & AddLib(wxString const &aName, wxString const &aDesc)
Construct an empty library node, add it to the root, and return it.

References LIB_TREE_NODE_ROOT::AddLib(), LIB_ID::GetLibNickname(), LIB_TREE_NODE::m_LibId, LIB_TREE_NODE::m_Pinned, LIB_TREE_MODEL_ADAPTER::m_pinnedLibs, and LIB_TREE_MODEL_ADAPTER::m_tree.

Referenced by LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ FindItem()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::FindItem ( const LIB_ID aLibId)
inherited

Returns tree item corresponding to part.

Parameters
aLibIdspecifies the part and library name to be searched for.
Returns
Tree data item representing the part. Might be invalid if nothings was found.

Definition at line 342 of file lib_tree_model_adapter.cpp.

343 {
344  for( std::unique_ptr<LIB_TREE_NODE>& lib: m_tree.m_Children )
345  {
346  if( lib->m_Name != aLibId.GetLibNickname() )
347  continue;
348 
349  // if part name is not specified, return the library node
350  if( aLibId.GetLibItemName() == "" )
351  return ToItem( lib.get() );
352 
353  for( std::unique_ptr<LIB_TREE_NODE>& alias: lib->m_Children )
354  {
355  if( alias->m_Name == aLibId.GetLibItemName() )
356  return ToItem( alias.get() );
357  }
358 
359  break; // could not find the part in the requested library
360  }
361 
362  return wxDataViewItem();
363 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
static wxDataViewItem ToItem(const LIB_TREE_NODE *aNode)
Convert #SYM_TREE_NODE -> wxDataViewItem.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:90
PTR_VECTOR m_Children

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_TREE_NODE::m_Children, LIB_TREE_MODEL_ADAPTER::m_tree, and LIB_TREE_MODEL_ADAPTER::ToItem().

◆ FinishTreeInitialization()

void LIB_TREE_MODEL_ADAPTER::FinishTreeInitialization ( )
inherited

A final-stage initialization to be called after the window hierarchy has been realized and the window sizes set.

Definition at line 385 of file lib_tree_model_adapter.cpp.

386 {
387  m_col_part->SetWidth( m_colWidths[PART_COL] );
388  m_col_desc->SetWidth( m_colWidths[DESC_COL] );
389 }

References LIB_TREE_MODEL_ADAPTER::DESC_COL, LIB_TREE_MODEL_ADAPTER::m_col_desc, LIB_TREE_MODEL_ADAPTER::m_col_part, LIB_TREE_MODEL_ADAPTER::m_colWidths, and LIB_TREE_MODEL_ADAPTER::PART_COL.

◆ Freeze()

void LIB_TREE_MODEL_ADAPTER::Freeze ( )
inlineinherited

◆ GenerateInfo()

wxString FP_TREE_MODEL_ADAPTER::GenerateInfo ( LIB_ID const &  aLibId,
int  aUnit 
)
overridevirtual

Reimplemented from LIB_TREE_MODEL_ADAPTER.

Definition at line 81 of file fp_tree_model_adapter.cpp.

82 {
83  return GenerateFootprintInfo( m_libs, aLibId );
84 }
wxString GenerateFootprintInfo(FP_LIB_TABLE *aFpLibTable, LIB_ID const &aLibId)
Return an HTML page describing a LIB_ID in a FP_LIB_TABLE.

References GenerateFootprintInfo(), and m_libs.

◆ GetAliasFor()

LIB_ID LIB_TREE_MODEL_ADAPTER::GetAliasFor ( const wxDataViewItem &  aSelection) const
inherited

Return the alias for the given item.

Parameters
aSelectionitem from the wxDataViewCtrl (see wxDataViewCtrl::GetSelection())
Returns
alias, or nullptr if none is selected

Definition at line 298 of file lib_tree_model_adapter.cpp.

299 {
300  const LIB_TREE_NODE* node = ToNode( aSelection );
301 
302  LIB_ID emptyId;
303 
304  if( !node )
305  return emptyId;
306 
307  return node->m_LibId;
308 }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.

References LIB_TREE_NODE::m_LibId, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetAttr()

bool LIB_TREE_MODEL_ADAPTER::GetAttr ( const wxDataViewItem &  aItem,
unsigned int  aCol,
wxDataViewItemAttr &  aAttr 
) const
overrideprotectedinherited

Get any formatting for an item.

Parameters
aItemitem to get formatting for
aColcolumn number of interest
aAttrreceiver for attributes
Returns
true if the item has non-default attributes

Definition at line 475 of file lib_tree_model_adapter.cpp.

478 {
479  if( IsFrozen() )
480  return false;
481 
482  LIB_TREE_NODE* node = ToNode( aItem );
483  wxASSERT( node );
484 
485  if( node->m_Type != LIB_TREE_NODE::LIBID )
486  {
487  // Currently only aliases are formatted at all
488  return false;
489  }
490 
491  if( !node->m_IsRoot && aCol == 0 )
492  {
493  // Names of non-root aliases are italicized
494  aAttr.SetItalic( true );
495  return true;
496  }
497  else
498  {
499  return false;
500  }
501 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
enum TYPE m_Type

References LIB_TREE_MODEL_ADAPTER::IsFrozen(), LIB_TREE_NODE::LIBID, LIB_TREE_NODE::m_IsRoot, LIB_TREE_NODE::m_Type, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetChildren()

unsigned int LIB_TREE_MODEL_ADAPTER::GetChildren ( const wxDataViewItem &  aItem,
wxDataViewItemArray &  aChildren 
) const
overrideinherited

Populate a list of all the children of an item.

Returns
number of children

Definition at line 366 of file lib_tree_model_adapter.cpp.

368 {
369  const LIB_TREE_NODE* node = ( aItem.IsOk() ? ToNode( aItem ) : &m_tree );
370 
371  if( node->m_Type == LIB_TREE_NODE::TYPE::ROOT
372  || node->m_Type == LIB_TREE_NODE::LIB
373  || ( m_show_units && node->m_Type == LIB_TREE_NODE::TYPE::LIBID ) )
374  {
375  return IntoArray( *node, aChildren );
376  }
377  else
378  {
379  return 0;
380  }
381 
382 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
static unsigned int IntoArray(const LIB_TREE_NODE &aNode, wxDataViewItemArray &aChildren)
Convert SYM_TREE_NODE's children to wxDataViewItemArray.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
enum TYPE m_Type

References LIB_TREE_MODEL_ADAPTER::IntoArray(), LIB_TREE_NODE::LIB, LIB_TREE_MODEL_ADAPTER::m_show_units, LIB_TREE_MODEL_ADAPTER::m_tree, LIB_TREE_NODE::m_Type, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetColumnCount()

unsigned int LIB_TREE_MODEL_ADAPTER::GetColumnCount ( ) const
inlineoverrideprotectedinherited

Definition at line 319 of file lib_tree_model_adapter.h.

319 { return NUM_COLS; }

References LIB_TREE_MODEL_ADAPTER::NUM_COLS.

◆ GetColumnType()

wxString LIB_TREE_MODEL_ADAPTER::GetColumnType ( unsigned int  aCol) const
inlineoverrideprotectedinherited

Return the type of data stored in the column as indicated by wxVariant::GetType()

Definition at line 324 of file lib_tree_model_adapter.h.

324 { return "string"; }

◆ GetContextMenuTool()

virtual TOOL_INTERACTIVE* LIB_TREE_MODEL_ADAPTER::GetContextMenuTool ( )
inlinevirtualinherited

Reimplemented in SYMBOL_TREE_SYNCHRONIZING_ADAPTER, and FP_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 274 of file lib_tree_model_adapter.h.

274 { return nullptr; }

◆ GetFilter()

SYM_FILTER_TYPE LIB_TREE_MODEL_ADAPTER::GetFilter ( ) const
inlineinherited

Return the active filter.

Definition at line 142 of file lib_tree_model_adapter.h.

142 { return m_filter; }

References LIB_TREE_MODEL_ADAPTER::m_filter.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), and SYMBOL_TREE_MODEL_ADAPTER::AddLibrary().

◆ getFootprints()

std::vector< LIB_TREE_ITEM * > FP_TREE_MODEL_ADAPTER::getFootprints ( const wxString &  aLibName)
protected

Definition at line 58 of file fp_tree_model_adapter.cpp.

59 {
60  std::vector<LIB_TREE_ITEM*> libList;
61 
62  auto fullListStart = GFootprintList.GetList().begin();
63  auto fullListEnd = GFootprintList.GetList().end();
64  std::unique_ptr<FOOTPRINT_INFO> dummy = std::make_unique<FOOTPRINT_INFO_IMPL>( aLibName, wxEmptyString );
65 
66  // List is sorted, so use a binary search to find the range of footnotes for our library
67  auto libBounds = std::equal_range( fullListStart, fullListEnd, dummy,
68  []( const std::unique_ptr<FOOTPRINT_INFO>& a,
69  const std::unique_ptr<FOOTPRINT_INFO>& b )
70  {
71  return StrNumCmp( a->GetLibNickname(), b->GetLibNickname(), false ) < 0;
72  } );
73 
74  for( auto i = libBounds.first; i != libBounds.second; ++i )
75  libList.push_back( i->get() );
76 
77  return libList;
78 }
const FPILIST & GetList() const
Was forced to add this by modview_frame.cpp.
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
Definition: cvpcb.cpp:140
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.

References dummy(), FOOTPRINT_LIST::GetList(), GFootprintList, and StrNumCmp().

Referenced by AddLibraries(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), and FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ GetItemCount()

int LIB_TREE_MODEL_ADAPTER::GetItemCount ( ) const
inherited

Return the number of symbols loaded in the tree.

Definition at line 331 of file lib_tree_model_adapter.cpp.

332 {
333  int n = 0;
334 
335  for( const std::unique_ptr<LIB_TREE_NODE>& lib: m_tree.m_Children )
336  n += lib->m_Children.size();
337 
338  return n;
339 }
PTR_VECTOR m_Children

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::m_tree.

Referenced by PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ GetLibrariesCount()

virtual int LIB_TREE_MODEL_ADAPTER::GetLibrariesCount ( ) const
inlinevirtualinherited

Return the number of libraries loaded in the tree.

Reimplemented in SYMBOL_TREE_SYNCHRONIZING_ADAPTER, and FP_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 243 of file lib_tree_model_adapter.h.

244  {
245  return m_tree.m_Children.size();
246  }
PTR_VECTOR m_Children

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::m_tree.

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount().

◆ GetParent()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::GetParent ( const wxDataViewItem &  aItem) const
overrideprotectedinherited

Get the parent of an item.

Returns
parent of aItem, or an invalid wxDataViewItem if parent is root

Definition at line 432 of file lib_tree_model_adapter.cpp.

433 {
434  if( m_freeze )
435  return ToItem( nullptr );
436 
437  LIB_TREE_NODE* node = ToNode( aItem );
438  LIB_TREE_NODE* parent = node ? node->m_Parent : nullptr;
439 
440  // wxDataViewModel has no root node, but rather top-level elements have
441  // an invalid (null) parent.
442  if( !node || !parent || parent->m_Type == LIB_TREE_NODE::TYPE::ROOT )
443  return ToItem( nullptr );
444  else
445  return ToItem( parent );
446 }
static wxDataViewItem ToItem(const LIB_TREE_NODE *aNode)
Convert #SYM_TREE_NODE -> wxDataViewItem.
LIB_TREE_NODE * m_Parent
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
enum TYPE m_Type

References LIB_TREE_MODEL_ADAPTER::m_freeze, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_Type, LIB_TREE_MODEL_ADAPTER::ToItem(), and LIB_TREE_MODEL_ADAPTER::ToNode().

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ GetPinningSymbol()

const wxString LIB_TREE_MODEL_ADAPTER::GetPinningSymbol ( ) const
inlineprotectedinherited
Returns
a unicode string to mark a node name like a pinned library name This is not an ASCII7 char, but a unicode char

Definition at line 362 of file lib_tree_model_adapter.h.

363  {
364  return wxString::FromUTF8( "☆ " );
365  }

Referenced by FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue().

◆ GetTreeNodeFor()

LIB_TREE_NODE * LIB_TREE_MODEL_ADAPTER::GetTreeNodeFor ( const wxDataViewItem &  aSelection) const
inherited

Definition at line 325 of file lib_tree_model_adapter.cpp.

326 {
327  return ToNode( aSelection );
328 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.

References LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetTypeFor()

LIB_TREE_NODE::TYPE LIB_TREE_MODEL_ADAPTER::GetTypeFor ( const wxDataViewItem &  aSelection) const
inherited

Return node type for the given item.

Parameters
aSelectionitem from the wxDataViewCtrl (see wxDataViewCtrl::GetSelection())
Returns
Type of the selected node, might be INVALID.

Definition at line 318 of file lib_tree_model_adapter.cpp.

319 {
320  const LIB_TREE_NODE* node = ToNode( aSelection );
321  return node ? node->m_Type : LIB_TREE_NODE::INVALID;
322 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
enum TYPE m_Type

References LIB_TREE_NODE::INVALID, LIB_TREE_NODE::m_Type, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetUnitFor()

int LIB_TREE_MODEL_ADAPTER::GetUnitFor ( const wxDataViewItem &  aSelection) const
inherited

Return the unit for the given item.

Parameters
aSelectionitem from the wxDataViewCtrl (see wxDataViewCtrl::GetSelection())
Returns
Unit, or zero if the alias itself is selected. Return valid is invalid if GetAliasFor() returns nullptr.

Definition at line 311 of file lib_tree_model_adapter.cpp.

312 {
313  const LIB_TREE_NODE* node = ToNode( aSelection );
314  return node ? node->m_Unit : 0;
315 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.

References LIB_TREE_NODE::m_Unit, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetValue()

void LIB_TREE_MODEL_ADAPTER::GetValue ( wxVariant &  aVariant,
const wxDataViewItem &  aItem,
unsigned int  aCol 
) const
overrideprotectedinherited

Get the value of an item.

Parameters
aVariantwxVariant to receive the data
aItemitem whose data will be placed into aVariant
aColcolumn number of the data

Definition at line 449 of file lib_tree_model_adapter.cpp.

452 {
453  if( IsFrozen() )
454  {
455  aVariant = wxEmptyString;
456  return;
457  }
458 
459  LIB_TREE_NODE* node = ToNode( aItem );
460  wxASSERT( node );
461 
462  switch( aCol )
463  {
464  default: // column == -1 is used for default Compare function
465  case 0:
466  aVariant = UnescapeString( node->m_Name );
467  break;
468  case 1:
469  aVariant = node->m_Desc;
470  break;
471  }
472 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
wxString UnescapeString(const wxString &aSource)

References LIB_TREE_MODEL_ADAPTER::IsFrozen(), LIB_TREE_NODE::m_Desc, LIB_TREE_NODE::m_Name, LIB_TREE_MODEL_ADAPTER::ToNode(), and UnescapeString().

◆ HasContainerColumns()

bool LIB_TREE_MODEL_ADAPTER::HasContainerColumns ( const wxDataViewItem &  aItem) const
overrideprotectedinherited

Check whether a container has columns too.

Definition at line 419 of file lib_tree_model_adapter.cpp.

420 {
421  return IsContainer( aItem );
422 }
bool IsContainer(const wxDataViewItem &aItem) const override
Check whether an item can have children.

References LIB_TREE_MODEL_ADAPTER::IsContainer().

◆ IntoArray()

unsigned int LIB_TREE_MODEL_ADAPTER::IntoArray ( const LIB_TREE_NODE aNode,
wxDataViewItemArray &  aChildren 
)
staticprotectedinherited

Convert SYM_TREE_NODE's children to wxDataViewItemArray.

Definition at line 52 of file lib_tree_model_adapter.cpp.

54 {
55  unsigned int n = 0;
56 
57  for( std::unique_ptr<LIB_TREE_NODE> const& child: aNode.m_Children )
58  {
59  if( child->m_Score > 0 )
60  {
61  aChildren.Add( ToItem( &*child ) );
62  ++n;
63  }
64  }
65 
66  return n;
67 }
static wxDataViewItem ToItem(const LIB_TREE_NODE *aNode)
Convert #SYM_TREE_NODE -> wxDataViewItem.
PTR_VECTOR m_Children

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::ToItem().

Referenced by LIB_TREE_MODEL_ADAPTER::GetChildren().

◆ IsContainer()

bool LIB_TREE_MODEL_ADAPTER::IsContainer ( const wxDataViewItem &  aItem) const
overrideprotectedinherited

Check whether an item can have children.

Definition at line 425 of file lib_tree_model_adapter.cpp.

426 {
427  LIB_TREE_NODE* node = ToNode( aItem );
428  return node ? node->m_Children.size() : true;
429 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
PTR_VECTOR m_Children

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::ToNode().

Referenced by LIB_TREE_MODEL_ADAPTER::HasContainerColumns().

◆ IsFrozen()

◆ RefreshTree()

void LIB_TREE_MODEL_ADAPTER::RefreshTree ( )
inherited

Definition at line 392 of file lib_tree_model_adapter.cpp.

393 {
394  // Yes, this is an enormous hack. But it works on all platforms, it doesn't suffer
395  // the On^2 sorting issues that ItemChanged() does on OSX, and it doesn't lose the
396  // user's scroll position (which re-attaching or deleting/re-inserting columns does).
397  static int walk = 1;
398 
399  int partWidth = m_col_part->GetWidth();
400  int descWidth = m_col_desc->GetWidth();
401 
402  // Only use the widths read back if they are non-zero.
403  // GTK returns the displayed width of the column, which is not calculated immediately
404  if( descWidth > 0 )
405  {
406  m_colWidths[PART_COL] = partWidth;
407  m_colWidths[DESC_COL] = descWidth;
408  }
409 
410  m_colWidths[PART_COL] += walk;
411  m_colWidths[DESC_COL] -= walk;
412 
413  m_col_part->SetWidth( m_colWidths[PART_COL] );
414  m_col_desc->SetWidth( m_colWidths[DESC_COL] );
415  walk = -walk;
416 }

References LIB_TREE_MODEL_ADAPTER::DESC_COL, LIB_TREE_MODEL_ADAPTER::m_col_desc, LIB_TREE_MODEL_ADAPTER::m_col_part, LIB_TREE_MODEL_ADAPTER::m_colWidths, and LIB_TREE_MODEL_ADAPTER::PART_COL.

◆ SaveColWidths()

void LIB_TREE_MODEL_ADAPTER::SaveColWidths ( )
inherited

Save the column widths to the config file.

This requires the tree view to still be valid.

Definition at line 106 of file lib_tree_model_adapter.cpp.

107 {
108  if( m_widget )
109  {
111  cfg->m_LibTree.column_width = m_widget->GetColumn( PART_COL )->GetWidth();
112  }
113 }
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:99
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:92

References APP_SETTINGS_BASE::LIB_TREE::column_width, Kiface(), KIFACE_BASE::KifaceSettings(), APP_SETTINGS_BASE::m_LibTree, LIB_TREE_MODEL_ADAPTER::m_widget, and LIB_TREE_MODEL_ADAPTER::PART_COL.

◆ SavePinnedItems()

void LIB_TREE_MODEL_ADAPTER::SavePinnedItems ( )
inherited

Definition at line 116 of file lib_tree_model_adapter.cpp.

117 {
119 
120  std::vector<wxString>& entries = ( m_pinnedKey == "pinned_symbol_libs" ) ?
121  project.m_PinnedSymbolLibs :
122  project.m_PinnedFootprintLibs;
123 
124  entries.clear();
125  m_pinnedLibs.clear();
126 
127  for( std::unique_ptr<LIB_TREE_NODE>& child: m_tree.m_Children )
128  {
129  if( child->m_Pinned )
130  {
131  m_pinnedLibs.push_back( child->m_LibId.GetLibNickname() );
132  entries.push_back( child->m_LibId.GetLibNickname() );
133  }
134  }
135 
136 
137 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:190
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:145
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:64
PTR_VECTOR m_Children

References PROJECT::GetProjectFile(), KIWAY_HOLDER::Kiway(), LIB_TREE_NODE::m_Children, LIB_TREE_MODEL_ADAPTER::m_parent, LIB_TREE_MODEL_ADAPTER::m_pinnedKey, LIB_TREE_MODEL_ADAPTER::m_pinnedLibs, LIB_TREE_MODEL_ADAPTER::m_tree, KIWAY::Prj(), and project.

◆ SetFilter()

void LIB_TREE_MODEL_ADAPTER::SetFilter ( SYM_FILTER_TYPE  aFilter)
inherited

Set the symbol filter type.

Must be set before adding libraries

Parameters
aFilterif SYM_FILTER_POWER, only power parts are loaded

Definition at line 140 of file lib_tree_model_adapter.cpp.

141 {
142  m_filter = aFilter;
143 }

References LIB_TREE_MODEL_ADAPTER::m_filter.

◆ SetPreselectNode()

void LIB_TREE_MODEL_ADAPTER::SetPreselectNode ( const LIB_ID aLibId,
int  aUnit 
)
inherited

Set the symbol name to be selected if there are no search results.

May be set at any time; updates at the next UpdateSearchString().

Parameters
aLibIdsymbol LIB_ID to be selected
aUnitunit to be selected, if > 0 (0 selects the alias itself)

Definition at line 152 of file lib_tree_model_adapter.cpp.

153 {
154  m_preselect_lib_id = aLibId;
155  m_preselect_unit = aUnit;
156 }

References LIB_TREE_MODEL_ADAPTER::m_preselect_lib_id, and LIB_TREE_MODEL_ADAPTER::m_preselect_unit.

Referenced by PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ SetValue()

bool LIB_TREE_MODEL_ADAPTER::SetValue ( const wxVariant &  aVariant,
const wxDataViewItem &  aItem,
unsigned int  aCol 
)
inlineoverrideprotectedinherited

Set the value of an item.

Does nothing - this model doesn't support editing.

Definition at line 341 of file lib_tree_model_adapter.h.

343  { return false; }

◆ ShowUnits()

void LIB_TREE_MODEL_ADAPTER::ShowUnits ( bool  aShow)
inherited

Whether or not to show units.

May be set at any time; updates at the next UpdateSearchString()

Parameters
aShowif true, units are displayed

Definition at line 146 of file lib_tree_model_adapter.cpp.

147 {
148  m_show_units = aShow;
149 }

References LIB_TREE_MODEL_ADAPTER::m_show_units.

◆ Thaw()

void LIB_TREE_MODEL_ADAPTER::Thaw ( )
inlineinherited

◆ ToItem()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::ToItem ( const LIB_TREE_NODE aNode)
staticprotectedinherited

Convert #SYM_TREE_NODE -> wxDataViewItem.

Definition at line 40 of file lib_tree_model_adapter.cpp.

41 {
42  return wxDataViewItem( const_cast<void*>( static_cast<void const*>( aNode ) ) );
43 }

Referenced by LIB_TREE_MODEL_ADAPTER::FindItem(), LIB_TREE_MODEL_ADAPTER::GetParent(), and LIB_TREE_MODEL_ADAPTER::IntoArray().

◆ ToNode()

◆ UpdateSearchString()

void LIB_TREE_MODEL_ADAPTER::UpdateSearchString ( const wxString &  aSearch,
bool  aState 
)
inherited

Set the search string provided by the user.

Parameters
aSearchfull, unprocessed search text
aStateif true, we are keeping the state and so we shouldn't collapse the tree

Definition at line 183 of file lib_tree_model_adapter.cpp.

184 {
185  {
186  wxWindowUpdateLocker updateLock( m_widget );
187 
188  // Even with the updateLock, wxWidgets sometimes ties its knickers in a knot trying to
189  // run a wxdataview_selection_changed_callback() on a row that has been deleted.
190  // https://bugs.launchpad.net/kicad/+bug/1756255
191  m_widget->UnselectAll();
192 
193  // This collapse is required before the call to "Freeze()" below. Once Freeze()
194  // is called, GetParent() will return nullptr. While this works for some calls, it
195  // segfaults when we have any expanded elements b/c the sub units in the tree don't
196  // have explicit references that are maintained over a search
197  // The tree will be expanded again below when we get our matches
198  //
199  // Also note that this cannot happen when we have deleted a symbol as GTK will also
200  // iterate over the tree in this case and find a symbol that has an invalid link
201  // and crash https://gitlab.com/kicad/code/kicad/-/issues/6910
202  if( !aState && !aSearch.IsNull() && m_tree.m_Children.size() )
203  {
204  for( std::unique_ptr<LIB_TREE_NODE>& child: m_tree.m_Children )
205  m_widget->Collapse( wxDataViewItem( &*child ) );
206  }
207 
208  // DO NOT REMOVE THE FREEZE/THAW. This freeze/thaw is a flag for this model adapter
209  // that tells it when it shouldn't trust any of the data in the model. When set, it will
210  // not return invalid data to the UI, since this invalid data can cause crashes.
211  // This is different than the update locker, which locks the UI aspects only.
212  Freeze();
213  BeforeReset();
214 
215  m_tree.ResetScore();
216 
217  for( std::unique_ptr<LIB_TREE_NODE>& child: m_tree.m_Children )
218  {
219  if( child->m_Pinned )
220  child->m_Score *= 2;
221  }
222 
223  wxStringTokenizer tokenizer( aSearch );
224 
225  while( tokenizer.HasMoreTokens() )
226  {
227  const wxString term = tokenizer.GetNextToken().Lower();
228  EDA_COMBINED_MATCHER matcher( term );
229 
230  m_tree.UpdateScore( matcher );
231  }
232 
233  m_tree.SortNodes();
234  AfterReset();
235  Thaw();
236  }
237 
238  LIB_TREE_NODE* bestMatch = ShowResults();
239 
240  if( !bestMatch )
241  bestMatch = ShowPreselect();
242 
243  if( !bestMatch )
244  bestMatch = ShowSingleLibrary();
245 
246  if( bestMatch )
247  {
248  wxDataViewItem item = wxDataViewItem( bestMatch );
249  m_widget->Select( item );
250 
251  // Make sure the *parent* item is visible. The selected item is the
252  // first (shown) child of the parent. So it's always right below the parent,
253  // and this way the user can also see what library the selected part belongs to,
254  // without having a case where the selection is off the screen (unless the
255  // window is a single row high, which is unlikely)
256  //
257  // This also happens to circumvent https://bugs.launchpad.net/kicad/+bug/1804400
258  // which appears to be a GTK+3 bug.
259  {
260  wxDataViewItem parent = GetParent( item );
261 
262  if( parent.IsOk() )
263  item = parent;
264  }
265 
266  m_widget->EnsureVisible( item );
267  }
268 }
void SortNodes()
Sort child nodes quickly and recursively (IntrinsicRanks must have been set).
LIB_TREE_NODE * ShowResults()
Find and expand successful search results.
LIB_TREE_NODE * ShowPreselect()
Find and expand preselected node.
wxDataViewItem GetParent(const wxDataViewItem &aItem) const override
Get the parent of an item.
void ResetScore()
Initialize score to kLowestDefaultScore, recursively.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
virtual void UpdateScore(EDA_COMBINED_MATCHER &aMatcher) override
Update the score for this part.
LIB_TREE_NODE * ShowSingleLibrary()
Find and expand a library if there is only one.
PTR_VECTOR m_Children

References LIB_TREE_MODEL_ADAPTER::Freeze(), LIB_TREE_MODEL_ADAPTER::GetParent(), LIB_TREE_NODE::m_Children, LIB_TREE_MODEL_ADAPTER::m_tree, LIB_TREE_MODEL_ADAPTER::m_widget, LIB_TREE_NODE::ResetScore(), LIB_TREE_MODEL_ADAPTER::ShowPreselect(), LIB_TREE_MODEL_ADAPTER::ShowResults(), LIB_TREE_MODEL_ADAPTER::ShowSingleLibrary(), LIB_TREE_NODE::SortNodes(), LIB_TREE_MODEL_ADAPTER::Thaw(), and LIB_TREE_NODE_ROOT::UpdateScore().

Member Data Documentation

◆ m_libs

FP_LIB_TABLE* FP_TREE_MODEL_ADAPTER::m_libs
protected

◆ m_tree


The documentation for this class was generated from the following files: