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  CMP_FILTER_TYPE { CMP_FILTER_NONE, CMP_FILTER_POWER }
 This enum allows a selective filtering of components 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...
 
typedef wxObjectDataPtr< LIB_TREE_MODEL_ADAPTERPTR
 Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER_BASE. 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 (CMP_FILTER_TYPE aFilter)
 Set the component filter type. More...
 
CMP_FILTER_TYPE GetFilter () const
 Return the active filter. More...
 
void ShowUnits (bool aShow)
 Whether or not to show units. More...
 
void SetPreselectNode (LIB_ID const &aLibId, int aUnit)
 Set the component name to be selected if there are no search results. More...
 
void DoAddLibrary (wxString const &aNodeName, wxString const &aDesc, std::vector< LIB_TREE_ITEM * > const &aItemList, bool presorted)
 Add the given list of components by alias. More...
 
void AssignIntrinsicRanks ()
 Sort the tree and assign ranks after adding libraries. More...
 
void UpdateSearchString (wxString const &aSearch)
 Set the search string provided by the user. More...
 
void AttachTo (wxDataViewCtrl *aDataViewCtrl)
 Attach to a wxDataViewCtrl and initialize it. 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 components 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 (wxDataViewItem const &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 PTR Create (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 (wxString const &aNodeName, wxString const &aDesc)
 
bool HasContainerColumns (wxDataViewItem const &aItem) const override
 Check whether a container has columns too. More...
 
bool IsContainer (wxDataViewItem const &aItem) const override
 Check whether an item can have children. More...
 
wxDataViewItem GetParent (wxDataViewItem const &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, wxDataViewItem const &aItem, unsigned int aCol) const override
 Get the value of an item. More...
 
bool SetValue (wxVariant const &aVariant, wxDataViewItem const &aItem, unsigned int aCol) override
 Set the value of an item. More...
 
bool GetAttr (wxDataViewItem const &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 (LIB_TREE_NODE const *aNode)
 Convert CMP_TREE_NODE -> wxDataViewItem. More...
 
static LIB_TREE_NODEToNode (wxDataViewItem aItem)
 Convert wxDataViewItem -> CMP_TREE_NODE. More...
 
static unsigned int IntoArray (LIB_TREE_NODE const &aNode, wxDataViewItemArray &aChildren)
 Convert CMP_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 Typedef Documentation

◆ PTR

typedef wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> LIB_TREE_MODEL_ADAPTER::PTR
inherited

Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER_BASE.

Definition at line 105 of file lib_tree_model_adapter.h.

Member Enumeration Documentation

◆ CMP_FILTER_TYPE

This enum allows a selective filtering of components to list.

Enumerator
CMP_FILTER_NONE 

no filtering

CMP_FILTER_POWER 

list components flagged PWR

Definition at line 116 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 125 of file lib_tree_model_adapter.h.

126  {
127  PART_COL = 0,
128  DESC_COL,
129  NUM_COLS
130  };

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 36 of file fp_tree_model_adapter.cpp.

36  :
37  LIB_TREE_MODEL_ADAPTER( aParent, "pinned_footprint_libs" ),
38  m_libs( (FP_LIB_TABLE*) aLibs )
39 {}
LIB_TREE_MODEL_ADAPTER(EDA_BASE_FRAME *aParent, wxString aPinnedKey)
Creates the adapter.

Referenced by Create().

Member Function Documentation

◆ AddLibraries()

void FP_TREE_MODEL_ADAPTER::AddLibraries ( )

Definition at line 42 of file fp_tree_model_adapter.cpp.

43 {
44  for( const auto& libName : m_libs->GetLogicalLibs() )
45  {
46  const FP_LIB_TABLE_ROW* library = m_libs->FindRow( libName );
47 
48  DoAddLibrary( libName, library->GetDescr(), getFootprints( libName ), true );
49  }
50 
52 }
void DoAddLibrary(wxString const &aNodeName, wxString const &aDesc, std::vector< LIB_TREE_ITEM * > const &aItemList, bool presorted)
Add the given list of components by alias.
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
const wxString & GetDescr() const
Return the description of the library referenced by this row.
std::vector< LIB_TREE_ITEM * > getFootprints(const wxString &aLibName)
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
void AssignIntrinsicRanks(bool presorted=false)
Store intrinsic ranks on all children of this node.
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(), LIB_TABLE_ROW::GetDescr(), getFootprints(), LIB_TABLE::GetLogicalLibs(), m_libs, and LIB_TREE_MODEL_ADAPTER::m_tree.

◆ AssignIntrinsicRanks()

void LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks ( )
inlineinherited

Sort the tree and assign ranks after adding libraries.

Definition at line 183 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 component in the dialog

Definition at line 272 of file lib_tree_model_adapter.cpp.

273 {
274  wxString partHead = _( "Item" );
275  wxString descHead = _( "Description" );
276 
277  // The extent of the text doesn't take into account the space on either side
278  // in the header, so artificially pad it by M
279  wxSize partHeadMinWidth = GetTextSize( partHead + "M", aDataViewCtrl );
280 
281  if( aDataViewCtrl->GetColumnCount() > 0 )
282  {
283  int partWidth = aDataViewCtrl->GetColumn( PART_COL )->GetWidth();
284  int descWidth = aDataViewCtrl->GetColumn( DESC_COL )->GetWidth();
285 
286  // Only use the widths read back if they are non-zero.
287  // GTK returns the displayed width of the column, which is not calculated immediately
288  // this leads to cases of 0 column width if the user types too fast in the filter
289  if( descWidth > 0 )
290  {
291  m_colWidths[PART_COL] = partWidth;
292  m_colWidths[DESC_COL] = descWidth;
293  }
294  }
295 
296  m_widget = aDataViewCtrl;
297  aDataViewCtrl->SetIndent( kDataViewIndent );
298  aDataViewCtrl->AssociateModel( this );
299  aDataViewCtrl->ClearColumns();
300 
301  m_col_part = aDataViewCtrl->AppendTextColumn( partHead, PART_COL, wxDATAVIEW_CELL_INERT,
303  m_col_desc = aDataViewCtrl->AppendTextColumn( descHead, DESC_COL, wxDATAVIEW_CELL_INERT,
305 
306  // Ensure the part column is wider than the smallest allowable width
307  if( m_colWidths[PART_COL] < partHeadMinWidth.x )
308  {
309  m_colWidths[PART_COL] = partHeadMinWidth.x;
310  m_col_part->SetWidth( partHeadMinWidth.x );
311  }
312 
313  m_col_part->SetMinWidth( partHeadMinWidth.x );
314 }
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: common.cpp:268
static const int kDataViewIndent
#define _(s)
Definition: 3d_actions.cpp:33

References _, LIB_TREE_MODEL_ADAPTER::DESC_COL, 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.

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ Create()

FP_TREE_MODEL_ADAPTER::PTR 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 29 of file fp_tree_model_adapter.cpp.

31 {
32  return PTR( new FP_TREE_MODEL_ADAPTER( aParent, aLibs ) );
33 }
FP_TREE_MODEL_ADAPTER(EDA_BASE_FRAME *aParent, LIB_TABLE *aLibs)
Constructor; takes a set of libraries to be included in the search.
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > PTR
Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER_BASE.

References FP_TREE_MODEL_ADAPTER().

Referenced by PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ DoAddLibrary()

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

Add the given list of components by alias.

To be called in the setup phase.

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

Definition at line 176 of file lib_tree_model_adapter.cpp.

179 {
180  LIB_TREE_NODE_LIB& lib_node = DoAddLibraryNode( aNodeName, aDesc );
181 
182  for( LIB_TREE_ITEM* item: aItemList )
183  lib_node.AddItem( item );
184 
185  lib_node.AssignIntrinsicRanks( presorted );
186 }
A mix-in to provide polymorphism between items stored in libraries (symbols, aliases and footprints).
Definition: lib_tree_item.h:39
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.
LIB_TREE_NODE_LIB & DoAddLibraryNode(wxString const &aNodeName, wxString const &aDesc)
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::AddLibrary(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ DoAddLibraryNode()

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

Definition at line 165 of file lib_tree_model_adapter.cpp.

167 {
168  LIB_TREE_NODE_LIB& lib_node = m_tree.AddLib( aNodeName, aDesc );
169 
170  lib_node.m_Pinned = m_pinnedLibs.Index( lib_node.m_LibId.GetLibNickname() ) != wxNOT_FOUND;
171 
172  return lib_node;
173 }
Node type: library.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
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 361 of file lib_tree_model_adapter.cpp.

362 {
363  for( auto& lib: m_tree.m_Children )
364  {
365  if( lib->m_Name != aLibId.GetLibNickname() )
366  continue;
367 
368  // if part name is not specified, return the library node
369  if( aLibId.GetLibItemName() == "" )
370  return ToItem( lib.get() );
371 
372  for( auto& alias: lib->m_Children )
373  {
374  if( alias->m_Name == aLibId.GetLibItemName() )
375  return ToItem( alias.get() );
376  }
377 
378  break; // could not find the part in the requested library
379  }
380 
381  return wxDataViewItem();
382 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
static wxDataViewItem ToItem(LIB_TREE_NODE const *aNode)
Convert CMP_TREE_NODE -> wxDataViewItem.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
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().

◆ 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 77 of file fp_tree_model_adapter.cpp.

78 {
79  return GenerateFootprintInfo( m_libs, aLibId );
80 }
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 317 of file lib_tree_model_adapter.cpp.

318 {
319  const LIB_TREE_NODE* node = ToNode( aSelection );
320 
321  LIB_ID emptyId;
322 
323  if( !node )
324  return emptyId;
325 
326  return node->m_LibId;
327 }
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 -> CMP_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 ( wxDataViewItem const &  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 iff the item has non-default attributes

Definition at line 481 of file lib_tree_model_adapter.cpp.

484 {
485  if( IsFrozen() )
486  return false;
487 
488  LIB_TREE_NODE* node = ToNode( aItem );
489  wxASSERT( node );
490 
491  if( node->m_Type != LIB_TREE_NODE::LIBID )
492  {
493  // Currently only aliases are formatted at all
494  return false;
495  }
496 
497  if( !node->m_IsRoot && aCol == 0 )
498  {
499  // Names of non-root aliases are italicized
500  aAttr.SetItalic( true );
501  return true;
502  }
503  else
504  {
505  return false;
506  }
507 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> CMP_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 ( wxDataViewItem const &  aItem,
wxDataViewItemArray &  aChildren 
) const
overrideinherited

Populate a list of all the children of an item.

Returns
number of children

Definition at line 385 of file lib_tree_model_adapter.cpp.

387 {
388  const LIB_TREE_NODE* node = ( aItem.IsOk() ? ToNode( aItem ) : &m_tree );
389 
390  if( node->m_Type != LIB_TREE_NODE::TYPE::LIBID
391  || ( m_show_units && node->m_Type == LIB_TREE_NODE::TYPE::LIBID ) )
392  return IntoArray( *node, aChildren );
393  else
394  return 0;
395 }
static unsigned int IntoArray(LIB_TREE_NODE const &aNode, wxDataViewItemArray &aChildren)
Convert CMP_TREE_NODE's children to wxDataViewItemArray.
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> CMP_TREE_NODE.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
enum TYPE m_Type

References LIB_TREE_MODEL_ADAPTER::IntoArray(), 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 309 of file lib_tree_model_adapter.h.

309 { 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 314 of file lib_tree_model_adapter.h.

314 { 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()

CMP_FILTER_TYPE LIB_TREE_MODEL_ADAPTER::GetFilter ( ) const
inlineinherited

Return the active filter.

Definition at line 149 of file lib_tree_model_adapter.h.

149 { return m_filter; }

References LIB_TREE_MODEL_ADAPTER::m_filter.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibrary().

◆ getFootprints()

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

Definition at line 55 of file fp_tree_model_adapter.cpp.

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

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 components loaded in the tree.

Definition at line 350 of file lib_tree_model_adapter.cpp.

351 {
352  int n = 0;
353 
354  for( const std::unique_ptr<LIB_TREE_NODE>& lib: m_tree.m_Children )
355  n += lib->m_Children.size();
356 
357  return n;
358 }
PTR_VECTOR m_Children

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

◆ 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 ( wxDataViewItem const &  aItem) const
overrideprotectedinherited

Get the parent of an item.

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

Definition at line 438 of file lib_tree_model_adapter.cpp.

439 {
440  if( m_freeze )
441  return ToItem( nullptr );
442 
443  LIB_TREE_NODE* node = ToNode( aItem );
444  LIB_TREE_NODE* parent = node ? node->m_Parent : nullptr;
445 
446  // wxDataViewModel has no root node, but rather top-level elements have
447  // an invalid (null) parent.
448  if( !node || !parent || parent->m_Type == LIB_TREE_NODE::TYPE::ROOT )
449  return ToItem( nullptr );
450  else
451  return ToItem( parent );
452 }
static wxDataViewItem ToItem(LIB_TREE_NODE const *aNode)
Convert CMP_TREE_NODE -> wxDataViewItem.
LIB_TREE_NODE * m_Parent
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> CMP_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 352 of file lib_tree_model_adapter.h.

353  {
354  return wxString::FromUTF8( "☆ " );
355  }

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 344 of file lib_tree_model_adapter.cpp.

345 {
346  return ToNode( aSelection );
347 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> CMP_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 337 of file lib_tree_model_adapter.cpp.

338 {
339  const LIB_TREE_NODE* node = ToNode( aSelection );
340  return node ? node->m_Type : LIB_TREE_NODE::INVALID;
341 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> CMP_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 330 of file lib_tree_model_adapter.cpp.

331 {
332  const LIB_TREE_NODE* node = ToNode( aSelection );
333  return node ? node->m_Unit : 0;
334 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> CMP_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,
wxDataViewItem const &  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 455 of file lib_tree_model_adapter.cpp.

458 {
459  if( IsFrozen() )
460  {
461  aVariant = wxEmptyString;
462  return;
463  }
464 
465  LIB_TREE_NODE* node = ToNode( aItem );
466  wxASSERT( node );
467 
468  switch( aCol )
469  {
470  default: // column == -1 is used for default Compare function
471  case 0:
472  aVariant = node->m_Name;
473  break;
474  case 1:
475  aVariant = node->m_Desc;
476  break;
477  }
478 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> CMP_TREE_NODE.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
wxString m_Name
wxString m_Desc

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

◆ HasContainerColumns()

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

Check whether a container has columns too.

Definition at line 425 of file lib_tree_model_adapter.cpp.

426 {
427  return IsContainer( aItem );
428 }
bool IsContainer(wxDataViewItem const &aItem) const override
Check whether an item can have children.

References LIB_TREE_MODEL_ADAPTER::IsContainer().

◆ IntoArray()

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

Convert CMP_TREE_NODE's children to wxDataViewItemArray.

Definition at line 59 of file lib_tree_model_adapter.cpp.

61 {
62  unsigned int n = 0;
63 
64  for( auto const& child: aNode.m_Children )
65  {
66  if( child->m_Score > 0 )
67  {
68  aChildren.Add( ToItem( &*child ) );
69  ++n;
70  }
71  }
72 
73  return n;
74 }
static wxDataViewItem ToItem(LIB_TREE_NODE const *aNode)
Convert CMP_TREE_NODE -> wxDataViewItem.

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 ( wxDataViewItem const &  aItem) const
overrideprotectedinherited

Check whether an item can have children.

Definition at line 431 of file lib_tree_model_adapter.cpp.

432 {
433  LIB_TREE_NODE* node = ToNode( aItem );
434  return node ? node->m_Children.size() : true;
435 }
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> CMP_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 398 of file lib_tree_model_adapter.cpp.

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

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 112 of file lib_tree_model_adapter.cpp.

113 {
114  if( m_widget )
115  {
116  auto cfg = Kiface().KifaceSettings();
117  cfg->m_LibTree.column_width = m_widget->GetColumn( PART_COL )->GetWidth();
118  }
119 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

References APP_SETTINGS_BASE::LIB_TREE::column_width, Kiface(), KIFACE_I::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 122 of file lib_tree_model_adapter.cpp.

123 {
124  PROJECT_FILE& project = m_parent->Kiway().Prj().GetProjectFile();
125 
126  std::vector<wxString>& entries = ( m_pinnedKey == "pinned_symbol_libs" ) ?
127  project.m_PinnedSymbolLibs :
128  project.m_PinnedFootprintLibs;
129 
130  entries.clear();
131  m_pinnedLibs.clear();
132 
133  for( auto& child: m_tree.m_Children )
134  {
135  if( child->m_Pinned )
136  {
137  m_pinnedLibs.push_back( child->m_LibId.GetLibNickname() );
138  entries.push_back( child->m_LibId.GetLibNickname() );
139  }
140  }
141 
142 
143 }
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
Definition: project_file.h:123
std::vector< wxString > m_PinnedFootprintLibs
The list of pinned footprint libraries.
Definition: project_file.h:126
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:173
PROJECT_FILE is the backing store for a PROJECT, in JSON format.
Definition: project_file.h:62
VTBL_ENTRY PROJECT_FILE & GetProjectFile() const
Definition: project.h:141
PTR_VECTOR m_Children

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

◆ SetFilter()

void LIB_TREE_MODEL_ADAPTER::SetFilter ( CMP_FILTER_TYPE  aFilter)
inherited

Set the component filter type.

Must be set before adding libraries

Parameters
aFilterif CMP_FILTER_POWER, only power parts are loaded

Definition at line 146 of file lib_tree_model_adapter.cpp.

147 {
148  m_filter = aFilter;
149 }

References LIB_TREE_MODEL_ADAPTER::m_filter.

◆ SetPreselectNode()

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

Set the component 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 158 of file lib_tree_model_adapter.cpp.

159 {
160  m_preselect_lib_id = aLibId;
161  m_preselect_unit = aUnit;
162 }

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

◆ SetValue()

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

Set the value of an item.

Does nothing - this model doesn't support editing.

Definition at line 331 of file lib_tree_model_adapter.h.

333  { 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 152 of file lib_tree_model_adapter.cpp.

153 {
154  m_show_units = aShow;
155 }

References LIB_TREE_MODEL_ADAPTER::m_show_units.

◆ Thaw()

void LIB_TREE_MODEL_ADAPTER::Thaw ( )
inlineinherited

◆ ToItem()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::ToItem ( LIB_TREE_NODE const *  aNode)
staticprotectedinherited

Convert CMP_TREE_NODE -> wxDataViewItem.

Definition at line 41 of file lib_tree_model_adapter.cpp.

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

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 ( wxString const &  aSearch)
inherited

Set the search string provided by the user.

Parameters
aSearchfull, unprocessed search text

Definition at line 189 of file lib_tree_model_adapter.cpp.

190 {
191  {
192  // DO NOT REMOVE THE FREEZE/THAW. This freeze/thaw is a flag for this model adapter
193  // that tells it when it shouldn't trust any of the data in the model. When set, it will
194  // not return invalid data to the UI, since this invalid data can cause crashes.
195  // This is different than the update locker, which locks the UI aspects only.
196  wxWindowUpdateLocker updateLock( m_widget );
197  Freeze();
198 
199  m_tree.ResetScore();
200 
201  for( auto& child: m_tree.m_Children )
202  {
203  if( child->m_Pinned )
204  child->m_Score *= 2;
205  }
206 
207  wxStringTokenizer tokenizer( aSearch );
208 
209  while( tokenizer.HasMoreTokens() )
210  {
211  const wxString term = tokenizer.GetNextToken().Lower();
212  EDA_COMBINED_MATCHER matcher( term );
213 
214  m_tree.UpdateScore( matcher );
215  }
216 
217  // Even with the updateLock, wxWidgets sometimes ties its knickers in
218  // a knot when trying to run a wxdataview_selection_changed_callback()
219  // on a row that has been deleted.
220  // https://bugs.launchpad.net/kicad/+bug/1756255
221  m_widget->UnselectAll();
222 
223  m_tree.SortNodes();
224  Cleared();
225  Thaw();
226 
227  // This was fixed in wxWidgets 3.0.5 and 3.1.3.
228 #if defined( __WXGTK__ ) && ( (wxVERSION_NUMBER < 030005 ) || \
229  ( ( wxVERSION_NUMBER >= 030100 ) && ( wxVERSION_NUMBER < 030103 ) ) )
230  // The fastest method to update wxDataViewCtrl is to rebuild from
231  // scratch by calling Cleared(). Linux requires to reassociate model to
232  // display data, but Windows will create multiple associations.
233  // On MacOS, this crashes kicad. See https://gitlab.com/kicad/code/kicad/issues/3666
234  // and https://gitlab.com/kicad/code/kicad/issues/3653
235  AttachTo( m_widget );
236 #endif
237  }
238 
239  LIB_TREE_NODE* bestMatch = ShowResults();
240 
241  if( !bestMatch )
242  bestMatch = ShowPreselect();
243 
244  if( !bestMatch )
245  bestMatch = ShowSingleLibrary();
246 
247  if( bestMatch )
248  {
249  auto item = wxDataViewItem( bestMatch );
250  m_widget->Select( item );
251 
252  // Make sure the *parent* item is visible. The selected item is the
253  // first (shown) child of the parent. So it's always right below the parent,
254  // and this way the user can also see what library the selected part belongs to,
255  // without having a case where the selection is off the screen (unless the
256  // window is a single row high, which is unlikely)
257  //
258  // This also happens to circumvent https://bugs.launchpad.net/kicad/+bug/1804400
259  // which appears to be a GTK+3 bug.
260  {
261  wxDataViewItem parent = GetParent( item );
262 
263  if( parent.IsOk() )
264  item = parent;
265  }
266 
267  m_widget->EnsureVisible( item );
268  }
269 }
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(wxDataViewItem const &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
void AttachTo(wxDataViewCtrl *aDataViewCtrl)
Attach to a wxDataViewCtrl and initialize it.

References LIB_TREE_MODEL_ADAPTER::AttachTo(), 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: