KiCad PCB EDA Suite
SYMBOL_TREE_SYNCHRONIZING_ADAPTER Class Reference

#include <symbol_tree_synchronizing_adapter.h>

Inheritance diagram for SYMBOL_TREE_SYNCHRONIZING_ADAPTER:
LIB_TREE_MODEL_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

bool IsContainer (const wxDataViewItem &aItem) const override
 
void Sync (const wxString &aForceRefresh, std::function< void(int, int, const wxString &)> aProgressCallback)
 
int GetLibrariesCount () const override
 Return the number of libraries loaded in the tree. More...
 
TOOL_INTERACTIVEGetContextMenuTool () 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
 
virtual wxString GenerateInfo (const LIB_ID &aLibId, int aUnit)
 
int GetItemCount () const
 Return the number of symbols 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 ()
 

Static Public Member Functions

static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTERCreate (SYMBOL_EDIT_FRAME *aParent, SYMBOL_LIBRARY_MANAGER *aLibs)
 

Protected Member Functions

void updateLibrary (LIB_TREE_NODE_LIB &aLibNode)
 
LIB_TREE_NODE::PTR_VECTOR::iterator deleteLibrary (LIB_TREE_NODE::PTR_VECTOR::iterator &aLibNodeIt)
 
void GetValue (wxVariant &aVariant, wxDataViewItem const &aItem, unsigned int aCol) const override
 
bool GetAttr (wxDataViewItem const &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
 
 SYMBOL_TREE_SYNCHRONIZING_ADAPTER (SYMBOL_EDIT_FRAME *aParent, SYMBOL_LIBRARY_MANAGER *aLibMgr)
 
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...
 
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...
 
bool SetValue (const wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) override
 Set the value of 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

SYMBOL_EDIT_FRAMEm_frame
 
SYMBOL_LIBRARY_MANAGERm_libMgr
 Hashes to decide whether a library needs an update. More...
 
std::map< wxString, int > m_libHashes
 SYMBOL_LIBRARY_MANAGER hash value returned in the last synchronization. More...
 
int m_lastSyncHash
 
LIB_TREE_NODE_ROOT m_tree
 

Detailed Description

Definition at line 36 of file symbol_tree_synchronizing_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

◆ SYMBOL_TREE_SYNCHRONIZING_ADAPTER()

SYMBOL_TREE_SYNCHRONIZING_ADAPTER::SYMBOL_TREE_SYNCHRONIZING_ADAPTER ( SYMBOL_EDIT_FRAME aParent,
SYMBOL_LIBRARY_MANAGER aLibMgr 
)
protected

Definition at line 42 of file symbol_tree_synchronizing_adapter.cpp.

43  :
44  LIB_TREE_MODEL_ADAPTER( aParent, "pinned_symbol_libs" ),
45  m_frame( aParent ),
46  m_libMgr( aLibMgr ),
47  m_lastSyncHash( -1 )
48 {
49 }
LIB_TREE_MODEL_ADAPTER(EDA_BASE_FRAME *aParent, const wxString &aPinnedKey)
Create the adapter.
SYMBOL_LIBRARY_MANAGER * m_libMgr
Hashes to decide whether a library needs an update.

Referenced by Create().

Member Function Documentation

◆ 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 > SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Create ( SYMBOL_EDIT_FRAME aParent,
SYMBOL_LIBRARY_MANAGER aLibs 
)
static

Definition at line 34 of file symbol_tree_synchronizing_adapter.cpp.

36 {
37  auto* adapter = new SYMBOL_TREE_SYNCHRONIZING_ADAPTER( aParent, aLibMgr );
38  return wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>( adapter );
39 }
SYMBOL_TREE_SYNCHRONIZING_ADAPTER(SYMBOL_EDIT_FRAME *aParent, SYMBOL_LIBRARY_MANAGER *aLibMgr)

References SYMBOL_TREE_SYNCHRONIZING_ADAPTER().

Referenced by SYMBOL_LIBRARY_MANAGER::SYMBOL_LIBRARY_MANAGER().

◆ deleteLibrary()

LIB_TREE_NODE::PTR_VECTOR::iterator SYMBOL_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary ( LIB_TREE_NODE::PTR_VECTOR::iterator &  aLibNodeIt)
protected

Definition at line 192 of file symbol_tree_synchronizing_adapter.cpp.

194 {
195  LIB_TREE_NODE* node = aLibNodeIt->get();
196  m_libHashes.erase( node->m_Name );
197  auto it = m_tree.m_Children.erase( aLibNodeIt );
198  return it;
199 }
std::map< wxString, int > m_libHashes
SYMBOL_LIBRARY_MANAGER hash value returned in the last synchronization.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
PTR_VECTOR m_Children

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

Referenced by Sync().

◆ 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 FP_TREE_MODEL_ADAPTER::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 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()

virtual wxString LIB_TREE_MODEL_ADAPTER::GenerateInfo ( const LIB_ID aLibId,
int  aUnit 
)
inlinevirtualinherited

Reimplemented in SYMBOL_TREE_MODEL_ADAPTER, and FP_TREE_MODEL_ADAPTER.

Definition at line 233 of file lib_tree_model_adapter.h.

233 { return wxEmptyString; };

◆ 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 SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr ( wxDataViewItem const &  aItem,
unsigned int  aCol,
wxDataViewItemAttr &  aAttr 
) const
overrideprotected

Definition at line 271 of file symbol_tree_synchronizing_adapter.cpp.

273 {
274  if( IsFrozen() )
275  return false;
276 
277  LIB_TREE_NODE* node = ToNode( aItem );
278  wxCHECK( node, false );
279 
280  // Mark both columns of unloaded libraries using grey text color (to look disabled)
281  if( node->m_Type == LIB_TREE_NODE::LIB && !m_libMgr->IsLibraryLoaded( node->m_Name ) )
282  {
283  aAttr.SetColour( wxSystemSettings::GetColour( wxSYS_COLOUR_GRAYTEXT ) );
284  return true;
285  }
286 
287  // The remaining attributes are only for the name column
288  if( aCol != 0 )
289  return false;
290 
291  LIB_SYMBOL* curSymbol = m_frame->GetCurSymbol();
292 
293  switch( node->m_Type )
294  {
295  case LIB_TREE_NODE::LIB:
296  // mark modified libs with bold font
297  aAttr.SetBold( m_libMgr->IsLibraryModified( node->m_Name ) );
298 
299  // mark the current library with background color
300  if( curSymbol && curSymbol->GetLibId().GetLibNickname() == node->m_LibId.GetLibNickname() )
301  {
302 #ifdef __WXGTK__
303  // The native wxGTK+ impl ignores background colour, so set the text colour instead.
304  // This works reasonably well in dark themes, and quite poorly in light ones....
305  aAttr.SetColour( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT ) );
306 #else
307  aAttr.SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT ) );
308  aAttr.SetColour( wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT ) );
309 #endif
310  }
311  break;
312 
314  // mark modified part with bold font
315  aAttr.SetBold( m_libMgr->IsSymbolModified( node->m_Name, node->m_Parent->m_Name ) );
316 
317  // mark aliases with italic font
318  aAttr.SetItalic( !node->m_IsRoot );
319 
320  // mark the current part with background color
321  if( curSymbol && curSymbol->GetLibId() == node->m_LibId )
322  {
323 #ifdef __WXGTK__
324  // The native wxGTK+ impl ignores background colour, so set the text colour instead.
325  // This works reasonably well in dark themes, and quite poorly in light ones....
326  aAttr.SetColour( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT ) );
327 #else
328  aAttr.SetBackgroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_HIGHLIGHT ) );
329  aAttr.SetColour( wxSystemSettings::GetColour( wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT ) );
330 #endif
331  }
332  break;
333 
334  default:
335  return false;
336  }
337 
338  return true;
339 }
Define a library symbol object.
Definition: lib_symbol.h:96
LIB_SYMBOL * GetCurSymbol() const
Return the current symbol being edited or NULL if none selected.
LIB_ID GetLibId() const override
Definition: lib_symbol.h:135
LIB_TREE_NODE * m_Parent
bool IsSymbolModified(const wxString &aAlias, const wxString &aLibrary) const
Return true if symbol has unsaved modifications.
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:90
SYMBOL_LIBRARY_MANAGER * m_libMgr
Hashes to decide whether a library needs an update.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
bool IsLibraryModified(const wxString &aLibrary) const
Return true if library has unsaved modifications.
enum TYPE m_Type
bool IsLibraryLoaded(const wxString &aLibrary) const
Return true if the library was successfully loaded.

References SYMBOL_EDIT_FRAME::GetCurSymbol(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), LIB_TREE_MODEL_ADAPTER::IsFrozen(), SYMBOL_LIBRARY_MANAGER::IsLibraryLoaded(), SYMBOL_LIBRARY_MANAGER::IsLibraryModified(), SYMBOL_LIBRARY_MANAGER::IsSymbolModified(), LIB_TREE_NODE::LIB, LIB_TREE_NODE::LIBID, m_frame, LIB_TREE_NODE::m_IsRoot, LIB_TREE_NODE::m_LibId, m_libMgr, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Parent, 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()

TOOL_INTERACTIVE * SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool ( )
overridevirtual

Reimplemented from LIB_TREE_MODEL_ADAPTER.

Definition at line 52 of file symbol_tree_synchronizing_adapter.cpp.

53 {
55 }
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
Handle actions for the various symbol editor and viewers.

References TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), and m_frame.

◆ 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().

◆ 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()

int SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount ( ) const
overridevirtual

Return the number of libraries loaded in the tree.

Reimplemented from LIB_TREE_MODEL_ADAPTER.

Definition at line 129 of file symbol_tree_synchronizing_adapter.cpp.

130 {
132 
133  for( const wxString& libName : m_libMgr->GetLibraryNames() )
134  {
135  if( m_libHashes.count( libName ) == 0 )
136  ++count;
137  }
138 
139  return count;
140 }
virtual int GetLibrariesCount() const
Return the number of libraries loaded in the tree.
std::map< wxString, int > m_libHashes
SYMBOL_LIBRARY_MANAGER hash value returned in the last synchronization.
SYMBOL_LIBRARY_MANAGER * m_libMgr
Hashes to decide whether a library needs an update.
wxArrayString GetLibraryNames() const
Return the array of library names.

References LIB_TREE_MODEL_ADAPTER::GetLibrariesCount(), SYMBOL_LIBRARY_MANAGER::GetLibraryNames(), m_libHashes, and m_libMgr.

Referenced by Sync().

◆ 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 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 SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue ( wxVariant &  aVariant,
wxDataViewItem const &  aItem,
unsigned int  aCol 
) const
overrideprotected

Definition at line 202 of file symbol_tree_synchronizing_adapter.cpp.

204 {
205  if( IsFrozen() )
206  {
207  aVariant = wxEmptyString;
208  return;
209  }
210 
211  LIB_TREE_NODE* node = ToNode( aItem );
212  wxASSERT( node );
213 
214  switch( aCol )
215  {
216  case 0:
217  if( m_frame->GetCurSymbol() && m_frame->GetCurSymbol()->GetLibId() == node->m_LibId )
219 
220  if( node->m_Pinned )
221  aVariant = GetPinningSymbol() + UnescapeString( node->m_Name );
222  else
223  aVariant = UnescapeString( node->m_Name );
224 
225  // mark modified items with an asterisk
226  if( node->m_Type == LIB_TREE_NODE::LIB )
227  {
228  if( m_libMgr->IsLibraryModified( node->m_Name ) )
229  aVariant = aVariant.GetString() + " *";
230  }
231  else if( node->m_Type == LIB_TREE_NODE::LIBID )
232  {
233  if( m_libMgr->IsSymbolModified( node->m_Name, node->m_Parent->m_Name ) )
234  aVariant = aVariant.GetString() + " *";
235  }
236 
237  break;
238 
239  case 1:
240  if( m_frame->GetCurSymbol() && m_frame->GetCurSymbol()->GetLibId() == node->m_LibId )
241  {
243  }
244  else if( node->m_Type == LIB_TREE_NODE::LIB )
245  {
247  SYMBOL_LIB_TABLE_ROW* lib = libMgr.GetLibrary( node->m_LibId.GetLibNickname() );
248 
249  if( lib )
250  node->m_Desc = lib->GetDescr();
251  }
252 
253  aVariant = node->m_Desc;
254 
255  // Annotate that the library failed to load in the description column
256  if( node->m_Type == LIB_TREE_NODE::LIB )
257  {
258  if( !m_libMgr->IsLibraryLoaded( node->m_Name ) )
259  aVariant = _( "(failed to load)" ) + wxS( " " ) + aVariant.GetString();
260  }
261 
262  break;
263 
264  default: // column == -1 is used for default Compare function
265  aVariant = node->m_Name;
266  break;
267  }
268 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
const wxString & GetDescr() const
Return the description of the library referenced by this row.
LIB_SYMBOL * GetCurSymbol() const
Return the current symbol being edited or NULL if none selected.
SYMBOL_LIB_TABLE_ROW * GetLibrary(const wxString &aLibrary) const
Find a single library within the (aggregate) library table.
LIB_ID GetLibId() const override
Definition: lib_symbol.h:135
Class to handle modifications to the symbol libraries.
LIB_TREE_NODE * m_Parent
bool IsSymbolModified(const wxString &aAlias, const wxString &aLibrary) const
Return true if symbol has unsaved modifications.
SYMBOL_LIBRARY_MANAGER & GetLibManager()
#define _(s)
static LIB_TREE_NODE * ToNode(wxDataViewItem aItem)
Convert wxDataViewItem -> #SYM_TREE_NODE.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:90
SYMBOL_LIBRARY_MANAGER * m_libMgr
Hashes to decide whether a library needs an update.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
wxString UnescapeString(const wxString &aSource)
const wxString GetPinningSymbol() const
bool IsLibraryModified(const wxString &aLibrary) const
Return true if library has unsaved modifications.
enum TYPE m_Type
bool IsLibraryLoaded(const wxString &aLibrary) const
Return true if the library was successfully loaded.
wxString GetDescription() override
Definition: lib_symbol.h:142

References _, SYMBOL_EDIT_FRAME::GetCurSymbol(), LIB_TABLE_ROW::GetDescr(), LIB_SYMBOL::GetDescription(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), SYMBOL_EDIT_FRAME::GetLibManager(), LIB_ID::GetLibNickname(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), LIB_TREE_MODEL_ADAPTER::GetPinningSymbol(), LIB_TREE_MODEL_ADAPTER::IsFrozen(), SYMBOL_LIBRARY_MANAGER::IsLibraryLoaded(), SYMBOL_LIBRARY_MANAGER::IsLibraryModified(), SYMBOL_LIBRARY_MANAGER::IsSymbolModified(), LIB_TREE_NODE::LIB, LIB_TREE_NODE::LIBID, LIB_TREE_NODE::m_Desc, m_frame, LIB_TREE_NODE::m_LibId, m_libMgr, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_Pinned, LIB_TREE_NODE::m_Type, 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 SYMBOL_TREE_SYNCHRONIZING_ADAPTER::IsContainer ( const wxDataViewItem &  aItem) const
override

Definition at line 58 of file symbol_tree_synchronizing_adapter.cpp.

59 {
60  const LIB_TREE_NODE* node = ToNode( aItem );
61  return node ? node->m_Type == LIB_TREE_NODE::LIB : true;
62 }
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::LIB, LIB_TREE_NODE::m_Type, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ 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.

◆ Sync()

void SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync ( const wxString &  aForceRefresh,
std::function< void(int, int, const wxString &)>  aProgressCallback 
)

Definition at line 67 of file symbol_tree_synchronizing_adapter.cpp.

69 {
70  wxLongLong nextUpdate = wxGetUTCTimeMillis() + (PROGRESS_INTERVAL_MILLIS / 2);
71 
73  int i = 0, max = GetLibrariesCount();
74 
75  // Process already stored libraries
76  for( auto it = m_tree.m_Children.begin(); it != m_tree.m_Children.end(); /* iteration inside */ )
77  {
78  const wxString& name = it->get()->m_Name;
79 
80  if( wxGetUTCTimeMillis() > nextUpdate )
81  {
82  aProgressCallback( i, max, name );
83  nextUpdate = wxGetUTCTimeMillis() + PROGRESS_INTERVAL_MILLIS;
84  }
85 
86  // There is a bug in SYMBOL_LIBRARY_MANAGER::LibraryExists() that uses the buffered
87  // modified libraries before the symbol library table which prevents the library from
88  // being removed from the tree control.
89  if( !m_libMgr->LibraryExists( name, true )
90  || !m_frame->Prj().SchSymbolLibTable()->HasLibrary( name, true )
91  || m_frame->Prj().SchSymbolLibTable()->FindRow( name, true ) !=
92  m_frame->Prj().SchSymbolLibTable()->FindRow( name, false )
93  || name == aForceRefresh )
94  {
95  it = deleteLibrary( it );
96  continue;
97  }
98  else
99  {
100  updateLibrary( *(LIB_TREE_NODE_LIB*) it->get() );
101  }
102 
103  ++it;
104  ++i;
105  }
106 
107  // Look for new libraries
108  for( const wxString& libName : m_libMgr->GetLibraryNames() )
109  {
110  if( m_libHashes.count( libName ) == 0 )
111  {
112  if( wxGetUTCTimeMillis() > nextUpdate )
113  {
114  aProgressCallback( i++, max, libName );
115  nextUpdate = wxGetUTCTimeMillis() + PROGRESS_INTERVAL_MILLIS;
116  }
117 
119  LIB_TREE_NODE_LIB& lib_node = DoAddLibraryNode( libName, library->GetDescr() );
120 
121  updateLibrary( lib_node );
122  }
123  }
124 
126 }
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
LIB_TREE_NODE_LIB & DoAddLibraryNode(const wxString &aNodeName, const wxString &aDesc)
std::map< wxString, int > m_libHashes
SYMBOL_LIBRARY_MANAGER hash value returned in the last synchronization.
int GetLibrariesCount() const override
Return the number of libraries loaded in the tree.
#define PROGRESS_INTERVAL_MILLIS
SYMBOL_LIB_TABLE_ROW * GetLibrary(const wxString &aLibrary) const
Find a single library within the (aggregate) library table.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Node type: library.
SYMBOL_LIBRARY_MANAGER * m_libMgr
Hashes to decide whether a library needs an update.
wxArrayString GetLibraryNames() const
Return the array of library names.
LIB_TREE_NODE::PTR_VECTOR::iterator deleteLibrary(LIB_TREE_NODE::PTR_VECTOR::iterator &aLibNodeIt)
bool LibraryExists(const wxString &aLibrary, bool aCheckEnabled=false) const
Return true if library exists.
void AssignIntrinsicRanks(bool presorted=false)
Store intrinsic ranks on all children of this node.
const char * name
Definition: DXF_plotter.cpp:56
PTR_VECTOR m_Children

References LIB_TREE_NODE::AssignIntrinsicRanks(), deleteLibrary(), LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode(), SYMBOL_LIBRARY_MANAGER::GetHash(), GetLibrariesCount(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), SYMBOL_LIBRARY_MANAGER::GetLibraryNames(), library, SYMBOL_LIBRARY_MANAGER::LibraryExists(), LIB_TREE_NODE::m_Children, m_frame, m_lastSyncHash, m_libHashes, m_libMgr, LIB_TREE_MODEL_ADAPTER::m_tree, name, KIWAY_HOLDER::Prj(), PROGRESS_INTERVAL_MILLIS, and updateLibrary().

Referenced by SYMBOL_LIBRARY_MANAGER::Sync().

◆ 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()

◆ updateLibrary()

void SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary ( LIB_TREE_NODE_LIB aLibNode)
protected

Definition at line 143 of file symbol_tree_synchronizing_adapter.cpp.

144 {
145  auto hashIt = m_libHashes.find( aLibNode.m_Name );
146 
147  if( hashIt == m_libHashes.end() )
148  {
149  // add a new library
150  for( LIB_SYMBOL* alias : m_libMgr->GetAliases( aLibNode.m_Name ) )
151  aLibNode.AddItem( alias );
152  }
153  else if( hashIt->second != m_libMgr->GetLibraryHash( aLibNode.m_Name ) )
154  {
155  // update an existing library
156  std::list<LIB_SYMBOL*> aliases = m_libMgr->GetAliases( aLibNode.m_Name );
157 
158  // remove the common part from the aliases list
159  for( auto nodeIt = aLibNode.m_Children.begin(); nodeIt != aLibNode.m_Children.end(); )
160  {
161  auto aliasIt = std::find_if( aliases.begin(), aliases.end(),
162  [&] ( const LIB_SYMBOL* a )
163  {
164  return a->GetName() == (*nodeIt)->m_LibId.GetLibItemName();
165  } );
166 
167  if( aliasIt != aliases.end() )
168  {
169  // alias exists both in the symbol tree and the library manager,
170  // update only the node data.
171  static_cast<LIB_TREE_NODE_LIB_ID*>( nodeIt->get() )->Update( *aliasIt );
172  aliases.erase( aliasIt );
173  ++nodeIt;
174  }
175  else
176  {
177  // node does not exist in the library manager, remove the corresponding node
178  nodeIt = aLibNode.m_Children.erase( nodeIt );
179  }
180  }
181 
182  // now the aliases list contains only new aliases that need to be added to the tree
183  for( LIB_SYMBOL* alias : aliases )
184  aLibNode.AddItem( alias );
185  }
186 
187  aLibNode.AssignIntrinsicRanks();
188  m_libHashes[aLibNode.m_Name] = m_libMgr->GetLibraryHash( aLibNode.m_Name );
189 }
std::map< wxString, int > m_libHashes
SYMBOL_LIBRARY_MANAGER hash value returned in the last synchronization.
Define a library symbol object.
Definition: lib_symbol.h:96
LIB_TREE_NODE_LIB_ID & AddItem(LIB_TREE_ITEM *aItem)
Construct a new alias node, add it to this library, and return it.
int GetLibraryHash(const wxString &aLibrary) const
Return a library hash value to determine if it has changed.
SYMBOL_LIBRARY_MANAGER * m_libMgr
Hashes to decide whether a library needs an update.
void AssignIntrinsicRanks(bool presorted=false)
Store intrinsic ranks on all children of this node.
PTR_VECTOR m_Children
std::list< LIB_SYMBOL * > GetAliases(const wxString &aLibrary) const

References LIB_TREE_NODE_LIB::AddItem(), LIB_TREE_NODE::AssignIntrinsicRanks(), SYMBOL_LIBRARY_MANAGER::GetAliases(), SYMBOL_LIBRARY_MANAGER::GetLibraryHash(), LIB_TREE_NODE::m_Children, m_libHashes, m_libMgr, and LIB_TREE_NODE::m_Name.

Referenced by Sync().

◆ 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_frame

SYMBOL_EDIT_FRAME* SYMBOL_TREE_SYNCHRONIZING_ADAPTER::m_frame
protected

Definition at line 65 of file symbol_tree_synchronizing_adapter.h.

Referenced by GetAttr(), GetContextMenuTool(), GetValue(), and Sync().

◆ m_lastSyncHash

int SYMBOL_TREE_SYNCHRONIZING_ADAPTER::m_lastSyncHash
protected

Definition at line 72 of file symbol_tree_synchronizing_adapter.h.

Referenced by Sync().

◆ m_libHashes

std::map<wxString, int> SYMBOL_TREE_SYNCHRONIZING_ADAPTER::m_libHashes
protected

SYMBOL_LIBRARY_MANAGER hash value returned in the last synchronization.

Definition at line 69 of file symbol_tree_synchronizing_adapter.h.

Referenced by deleteLibrary(), GetLibrariesCount(), Sync(), and updateLibrary().

◆ m_libMgr

SYMBOL_LIBRARY_MANAGER* SYMBOL_TREE_SYNCHRONIZING_ADAPTER::m_libMgr
protected

Hashes to decide whether a library needs an update.

Definition at line 66 of file symbol_tree_synchronizing_adapter.h.

Referenced by GetAttr(), GetLibrariesCount(), GetValue(), Sync(), and updateLibrary().

◆ m_tree


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