#include <lib_tree_model.h>

Inheritance diagram for LIB_TREE_NODE_LIB_ID:

Public Types
enum	TYPE { ROOT, LIB, LIBID, UNIT, INVALID }

typedef std::vector< std::unique_ptr< LIB_TREE_NODE > >	PTR_VECTOR

Public Member Functions
	LIB_TREE_NODE_LIB_ID (LIB_TREE_NODE_LIB_ID const &_)=delete
	The addresses of CMP_TREE_NODEs are used as unique IDs for the wxDataViewModel, so don't let them be copied around. More...

void	operator= (LIB_TREE_NODE_LIB_ID const &_)=delete

	LIB_TREE_NODE_LIB_ID (LIB_TREE_NODE aParent, LIB_TREE_ITEM aItem)
	Construct a LIB_ID node. More...

void	Update (LIB_TREE_ITEM *aItem)
	Update the node using data from a LIB_ALIAS object. More...

virtual void	UpdateScore (EDA_COMBINED_MATCHER &aMatcher) override
	Perform the actual search. More...

void	ResetScore ()
	Initialize score to kLowestDefaultScore, recursively. More...

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

void	SortNodes ()
	Sort child nodes quickly and recursively (IntrinsicRanks must have been set). More...

Static Public Member Functions
static int	Compare (LIB_TREE_NODE const &aNode1, LIB_TREE_NODE const &aNode2)
	Compare two nodes. More...

Public Attributes
LIB_TREE_NODE *	m_Parent

PTR_VECTOR	m_Children

enum TYPE	m_Type

int	m_IntrinsicRank
	The rank of the item before any search terms are applied. More...

int	m_Score

bool	m_Pinned

wxString	m_Name

wxString	m_Desc

wxString	m_MatchName

wxString	m_SearchText

bool	m_Normalized

LIB_ID	m_LibId

int	m_Unit

bool	m_IsRoot

Protected Member Functions
LIB_TREE_NODE_UNIT &	AddUnit (LIB_TREE_ITEM *aItem, int aUnit)
	Add a new unit to the component and return it. More...

Detailed Description

Node type: LIB_ID.

Definition at line 180 of file lib_tree_model.h.

Member Typedef Documentation

◆ PTR_VECTOR

typedef std::vector<std::unique_ptr<LIB_TREE_NODE> > LIB_TREE_NODE::PTR_VECTOR

inherited

Definition at line 115 of file lib_tree_model.h.

Member Enumeration Documentation

◆ TYPE

enum LIB_TREE_NODE::TYPE

inherited

Enumerator
ROOT
LIB
LIBID
UNIT
INVALID

Definition at line 111 of file lib_tree_model.h.

  {
  ROOT, LIB, LIBID, UNIT, INVALID
  };

Constructor & Destructor Documentation

◆ LIB_TREE_NODE_LIB_ID() [1/2]

LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID ( LIB_TREE_NODE_LIB_ID const & _ )

delete

The addresses of CMP_TREE_NODEs are used as unique IDs for the wxDataViewModel, so don't let them be copied around.

◆ LIB_TREE_NODE_LIB_ID() [2/2]

LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID	(	LIB_TREE_NODE *	aParent,
		LIB_TREE_ITEM *	aItem
	)

Construct a LIB_ID node.

All fields will be populated from the LIB_ALIAS, including children (unit nodes will be generated automatically). This does not keep the pointer to the #LIB_ALIAS object because at any time, a #LIB_ALIAS can be remove from a library which will result in an invalid pointer. The alias must be resolved at the time of use. Anything else is a bug.

Parameters

aParent	parent node, should be a CMP_TREE_NODE_LIB
aItem	LIB_COMPONENT to populate the node.

Definition at line 157 of file lib_tree_model.cpp.

 {
  m_Type = LIBID;
  m_Parent = aParent;
 
  m_LibId.SetLibNickname( aItem->GetLibNickname() );
  m_LibId.SetLibItemName( aItem->GetName() );
 
  m_Name = aItem->GetName();
  m_Desc = aItem->GetDescription();
 
  m_MatchName = aItem->GetName();
  m_SearchText = aItem->GetSearchText();
  m_Normalized = false;
 
  m_IsRoot = aItem->IsRoot();
 
  if( aItem->GetUnitCount() > 1 )
  {
  for( int u = 1; u <= aItem->GetUnitCount(); ++u )
  AddUnit( aItem, u );
  }
 }

References AddUnit(), LIB_TREE_ITEM::GetDescription(), LIB_TREE_ITEM::GetLibNickname(), LIB_TREE_ITEM::GetName(), LIB_TREE_ITEM::GetSearchText(), LIB_TREE_ITEM::GetUnitCount(), LIB_TREE_ITEM::IsRoot(), LIB_TREE_NODE::LIBID, LIB_TREE_NODE::m_Desc, LIB_TREE_NODE::m_IsRoot, LIB_TREE_NODE::m_LibId, LIB_TREE_NODE::m_MatchName, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Normalized, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_SearchText, LIB_TREE_NODE::m_Type, LIB_ID::SetLibItemName(), and LIB_ID::SetLibNickname().

Member Function Documentation

◆ AddUnit()

LIB_TREE_NODE_UNIT & LIB_TREE_NODE_LIB_ID::AddUnit	(	LIB_TREE_ITEM *	aItem,
		int	aUnit
	)

protected

Add a new unit to the component and return it.

This should not be used directly, as the constructor adds all units.

Definition at line 182 of file lib_tree_model.cpp.

 {
  LIB_TREE_NODE_UNIT* unit = new LIB_TREE_NODE_UNIT( this, aItem, aUnit );
  m_Children.push_back( std::unique_ptr<LIB_TREE_NODE>( unit ) );
  return *unit;
 }

References LIB_TREE_NODE::m_Children.

Referenced by LIB_TREE_NODE_LIB_ID(), and Update().

◆ AssignIntrinsicRanks()

void LIB_TREE_NODE::AssignIntrinsicRanks ( bool presorted = false )

inherited

Store intrinsic ranks on all children of this node.

See m_IntrinsicRank member doc for more information.

Definition at line 62 of file lib_tree_model.cpp.

 {
  std::vector<LIB_TREE_NODE*> sort_buf;
 
  if( presorted )
  {
  int max = m_Children.size() - 1;
 
  for( int i = 0; i <= max; ++i )
  m_Children[i]->m_IntrinsicRank = max - i;
  }
  else
  {
  for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
  sort_buf.push_back( child.get() );
 
  std::sort( sort_buf.begin(), sort_buf.end(),
  []( LIB_TREE_NODE* a, LIB_TREE_NODE* b ) -> bool
  {
  return StrNumCmp( a->m_Name, b->m_Name, true ) > 0;
  } );
 
  for( int i = 0; i < (int) sort_buf.size(); ++i )
  sort_buf[i]->m_IntrinsicRank = i;
  }
 }

References LIB_TREE_NODE::m_Children, LIB_TREE_NODE::m_IntrinsicRank, LIB_TREE_NODE::m_Name, and StrNumCmp().

Referenced by FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks(), LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ Compare()

int LIB_TREE_NODE::Compare	(	LIB_TREE_NODE const &	aNode1,
		LIB_TREE_NODE const &	aNode2
	)

staticinherited

Compare two nodes.

Returns negative if aNode1 < aNode2, zero if aNode1 == aNode2, or positive if aNode1 > aNode2.

Definition at line 103 of file lib_tree_model.cpp.

 {
  if( aNode1.m_Type != aNode2.m_Type )
  return 0;
 
  if( aNode1.m_Score != aNode2.m_Score )
  return aNode1.m_Score - aNode2.m_Score;
 
  if( aNode1.m_Parent != aNode2.m_Parent )
  return 0;
 
  return aNode1.m_IntrinsicRank - aNode2.m_IntrinsicRank;
 }

References LIB_TREE_NODE::m_IntrinsicRank, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_Score, and LIB_TREE_NODE::m_Type.

Referenced by LIB_TREE_NODE::SortNodes().

◆ operator=()

void LIB_TREE_NODE_LIB_ID::operator= ( LIB_TREE_NODE_LIB_ID const & _ )

delete

◆ ResetScore()

void LIB_TREE_NODE::ResetScore ( )

inherited

Initialize score to kLowestDefaultScore, recursively.

Definition at line 53 of file lib_tree_model.cpp.

 {
  for( std::unique_ptr<LIB_TREE_NODE>& child: m_Children )
  child->ResetScore();
 
  m_Score = kLowestDefaultScore;
 }

References kLowestDefaultScore, LIB_TREE_NODE::m_Children, and LIB_TREE_NODE::m_Score.

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ SortNodes()

void LIB_TREE_NODE::SortNodes ( )

inherited

Sort child nodes quickly and recursively (IntrinsicRanks must have been set).

Definition at line 90 of file lib_tree_model.cpp.

 {
  std::sort( m_Children.begin(), m_Children.end(),
  []( std::unique_ptr<LIB_TREE_NODE>& a, std::unique_ptr<LIB_TREE_NODE>& b )
  {
  return Compare( *a, *b ) > 0;
  } );
 
  for( std::unique_ptr<LIB_TREE_NODE>& node: m_Children )
  node->SortNodes();
 }

References LIB_TREE_NODE::Compare(), and LIB_TREE_NODE::m_Children.

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ Update()

void LIB_TREE_NODE_LIB_ID::Update ( LIB_TREE_ITEM * aItem )

Update the node using data from a LIB_ALIAS object.

Definition at line 190 of file lib_tree_model.cpp.

 {
  // Update is called when the names match, so just update the other fields.
 
  m_LibId.SetLibNickname( aItem->GetLibId().GetLibNickname() );
 
  m_Desc = aItem->GetDescription();
 
  m_SearchText = aItem->GetSearchText();
  m_Normalized = false;
 
  m_IsRoot = aItem->IsRoot();
  m_Children.clear();
 
  for( int u = 1; u <= aItem->GetUnitCount(); ++u )
  AddUnit( aItem, u );
 }

References AddUnit(), LIB_TREE_ITEM::GetDescription(), LIB_TREE_ITEM::GetLibId(), LIB_ID::GetLibNickname(), LIB_TREE_ITEM::GetSearchText(), LIB_TREE_ITEM::GetUnitCount(), LIB_TREE_ITEM::IsRoot(), LIB_TREE_NODE::m_Children, LIB_TREE_NODE::m_Desc, LIB_TREE_NODE::m_IsRoot, LIB_TREE_NODE::m_LibId, LIB_TREE_NODE::m_Normalized, LIB_TREE_NODE::m_SearchText, and LIB_ID::SetLibNickname().

◆ UpdateScore()

void LIB_TREE_NODE_LIB_ID::UpdateScore ( EDA_COMBINED_MATCHER & aMatcher )

overridevirtual

Perform the actual search.

Implements LIB_TREE_NODE.

Definition at line 209 of file lib_tree_model.cpp.

 {
  if( m_Score <= 0 )
  return; // Leaf nodes without scores are out of the game.
 
  if( !m_Normalized )
  {
  m_MatchName = UnescapeString( m_MatchName ).Lower();
  m_SearchText = m_SearchText.Lower();
  m_Normalized = true;
  }
 
  // Keywords and description we only count if the match string is at
  // least two characters long. That avoids spurious, low quality
  // matches. Most abbreviations are at three characters long.
  int found_pos = EDA_PATTERN_NOT_FOUND;
  int matchers_fired = 0;
 
  if( aMatcher.GetPattern() == m_MatchName )
  {
  m_Score += 1000; // exact match. High score :)
  }
  else if( aMatcher.Find( m_MatchName, matchers_fired, found_pos ) )
  {
  // Substring match. The earlier in the string the better.
  m_Score += matchPosScore( found_pos, 20 ) + 20;
  }
  else if( aMatcher.Find( m_Parent->m_MatchName, matchers_fired, found_pos ) )
  {
  m_Score += 19; // parent name matches. score += 19
  }
  else if( aMatcher.Find( m_SearchText, matchers_fired, found_pos ) )
  {
  // If we have a very short search term (like one or two letters),
  // we don't want to accumulate scores if they just happen to be in
  // keywords or description as almost any one or two-letter
  // combination shows up in there.
  if( aMatcher.GetPattern().length() >= 2 )
  {
  // For longer terms, we add scores 1..18 for positional match
  // (higher in the front, where the keywords are).
  m_Score += matchPosScore( found_pos, 17 ) + 1;
  }
  }
  else
  {
  // No match. That's it for this item.
  m_Score = 0;
  }
 
  // More matchers = better match
  m_Score += 2 * matchers_fired;
 }

References EDA_PATTERN_NOT_FOUND, EDA_COMBINED_MATCHER::Find(), EDA_COMBINED_MATCHER::GetPattern(), LIB_TREE_NODE::m_MatchName, LIB_TREE_NODE::m_Normalized, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_Score, LIB_TREE_NODE::m_SearchText, matchPosScore(), and UnescapeString().

Member Data Documentation

◆ m_Children

PTR_VECTOR LIB_TREE_NODE::m_Children

inherited

Definition at line 118 of file lib_tree_model.h.

◆ m_Desc

wxString LIB_TREE_NODE::m_Desc

inherited

Definition at line 132 of file lib_tree_model.h.

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_MODEL_ADAPTER::GetValue(), LIB_TREE_NODE_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), and Update().

◆ m_IntrinsicRank

int LIB_TREE_NODE::m_IntrinsicRank

inherited

The rank of the item before any search terms are applied.

This is a fairly expensive sort (involving string compares) so it helps to store the result of that sort.

Definition at line 126 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE::AssignIntrinsicRanks(), LIB_TREE_NODE::Compare(), and LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT().

◆ m_IsRoot

bool LIB_TREE_NODE::m_IsRoot

inherited

Definition at line 140 of file lib_tree_model.h.

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), LIB_TREE_MODEL_ADAPTER::GetAttr(), LIB_TREE_NODE_LIB_ID(), and Update().

◆ m_LibId

LIB_ID LIB_TREE_NODE::m_LibId

inherited

Definition at line 138 of file lib_tree_model.h.

Referenced by LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode(), LIB_TREE_MODEL_ADAPTER::GetAliasFor(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_NODE_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), LIB_TREE_MODEL_ADAPTER::ShowPreselect(), and Update().

◆ m_MatchName

wxString LIB_TREE_NODE::m_MatchName

inherited

Definition at line 133 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), UpdateScore(), and LIB_TREE_NODE_LIB::UpdateScore().

◆ m_Name

wxString LIB_TREE_NODE::m_Name

inherited

Definition at line 131 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE::AssignIntrinsicRanks(), FP_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::deleteLibrary(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_MODEL_ADAPTER::GetValue(), LIB_TREE_NODE_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), FP_TREE_SYNCHRONIZING_ADAPTER::updateLibrary(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ m_Normalized

bool LIB_TREE_NODE::m_Normalized

inherited

Definition at line 135 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_LIB_ID(), Update(), and UpdateScore().

◆ m_Parent

LIB_TREE_NODE* LIB_TREE_NODE::m_Parent

inherited

Definition at line 117 of file lib_tree_model.h.

Referenced by LIB_TREE::centerIfValid(), LIB_TREE_NODE::Compare(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), LIB_TREE_MODEL_ADAPTER::GetParent(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), LIB_TREE_NODE_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), LIB_TREE_MODEL_ADAPTER::ShowPreselect(), LIB_TREE_MODEL_ADAPTER::ShowSingleLibrary(), and UpdateScore().

◆ m_Pinned

bool LIB_TREE_NODE::m_Pinned

inherited

Definition at line 129 of file lib_tree_model.h.

Referenced by LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), and SYMBOL_EDITOR_CONTROL::UnpinLibrary().

◆ m_Score

int LIB_TREE_NODE::m_Score

inherited

Definition at line 128 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE::Compare(), LIB_TREE_NODE::ResetScore(), LIB_TREE_MODEL_ADAPTER::ShowResults(), UpdateScore(), and LIB_TREE_NODE_LIB::UpdateScore().

◆ m_SearchText

wxString LIB_TREE_NODE::m_SearchText

inherited

Definition at line 134 of file lib_tree_model.h.

Referenced by LIB_TREE_NODE_LIB_ID(), Update(), and UpdateScore().

◆ m_Type

◆ m_Unit

int LIB_TREE_NODE::m_Unit

inherited

Definition at line 139 of file lib_tree_model.h.

Referenced by LIB_TREE_MODEL_ADAPTER::GetUnitFor(), LIB_TREE_NODE_UNIT::LIB_TREE_NODE_UNIT(), and LIB_TREE_MODEL_ADAPTER::ShowPreselect().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ PTR_VECTOR

Member Enumeration Documentation

◆ TYPE

Constructor & Destructor Documentation

◆ LIB_TREE_NODE_LIB_ID() [1/2]

◆ LIB_TREE_NODE_LIB_ID() [2/2]

Member Function Documentation

◆ AddUnit()

◆ AssignIntrinsicRanks()

◆ Compare()

◆ operator=()

◆ ResetScore()

◆ SortNodes()

◆ Update()

◆ UpdateScore()

Member Data Documentation

◆ m_Children

◆ m_Desc

◆ m_IntrinsicRank

◆ m_IsRoot

◆ m_LibId

◆ m_MatchName

◆ m_Name

◆ m_Normalized

◆ m_Parent

◆ m_Pinned

◆ m_Score

◆ m_SearchText

◆ m_Type

◆ m_Unit