Bi-directional index mapping a board's items keyed by identity (KIID). More...

#include <board_item_index.h>

Public Member Functions
	BOARD_ITEM_INDEX (BOARD &aOwner)

BOARD_ITEM *	Find (const KIID &aId)
	Return a cached item for aId if the entry is still self-consistent.

void	BindItem (BOARD_ITEM &aItem)
	Index aItem, replacing any previous entry for its UUID or address.

void	Unbind (const KIID &aId)
	Remove an item from the item-by-id cache.

void	UnbindItem (const BOARD_ITEM &aItem)
	Drop aItem itself.

void	Clear ()
	Drop every entry, clearing each item's link back to the board.

void	Rebind (BOARD_ITEM &aItem, const KIID &aNewId)
	Move aItem to aNewId, keeping the index in step with the item.

void	BindSubtree (BOARD_ITEM &aItem)

void	BindChildren (const BOARD_ITEM &aParent)

void	UnbindSubtree (const BOARD_ITEM &aItem)

void	UnbindChildren (const BOARD_ITEM &aParent)

bool	IsIndexed (const KIID &aId) const
	Return true if a forward entry for aId exists.

bool	IsIndexed (const BOARD_ITEM *aItem) const
	Return true if aItem is currently indexed.

Private Attributes
BOARD &	m_owner

std::unordered_map< KIID, BOARD_ITEM * >	m_itemsById
	Forward map from KIIDs to board items.

std::unordered_map< const BOARD_ITEM *, KIID >	m_idsByItem
	Reverse map from board items to their KIIDs.

Detailed Description

Bi-directional index mapping a board's items keyed by identity (KIID).

This index maintains a two-way mapping between KIIDs and board items' pointer identities. It is used to quickly look up board items by their KIIDs, in particular by functions such as BOARD::ResolveItem(), where it provides O(1) lookup for indexed items.

This index does not have any thread-safety guarantees.

Implications of being indexed:

Two maps record the forward and reverse mappings between KIIDs and board items.
Duplicate KIIDs are tolerated, with the later call evicting the previous entry, from the forward map but remains in the reverse map until it is re-bound or removed which is what BOARD::RepairDuplicateItemUuids() handles.

BOARD is the client of this index, and users of BOARDs interact with it only via the BOARD API (some of which are facades for this index).

FOOTPRINT boards keep an empty index: BindItem() and Rebind() return early there.

Definition at line 51 of file board_item_index.h.

Constructor & Destructor Documentation

◆ BOARD_ITEM_INDEX()

BOARD_ITEM_INDEX::BOARD_ITEM_INDEX ( BOARD & aOwner )

inlineexplicit

Definition at line 54 of file board_item_index.h.

References m_owner.

Member Function Documentation

◆ BindChildren()

void BOARD_ITEM_INDEX::BindChildren ( const BOARD_ITEM & aParent )

Definition at line 179 of file board_item_index.cpp.

References BindSubtree(), NO_RECURSE, and BOARD_ITEM::RunOnChildren().

◆ BindItem()

void BOARD_ITEM_INDEX::BindItem ( BOARD_ITEM & aItem )

Index aItem, replacing any previous entry for its UUID or address.

Definition at line 47 of file board_item_index.cpp.

References m_idsByItem, m_itemsById, m_owner, BOARD_ITEM::m_owningIndex, EDA_ITEM::m_Uuid, and UnbindItem().

Referenced by BindSubtree(), and Rebind().

◆ BindSubtree()

void BOARD_ITEM_INDEX::BindSubtree ( BOARD_ITEM & aItem )

Definition at line 167 of file board_item_index.cpp.

References BindItem(), BindSubtree(), NO_RECURSE, and BOARD_ITEM::RunOnChildren().

Referenced by BindChildren(), and BindSubtree().

◆ Clear()

void BOARD_ITEM_INDEX::Clear ( )

Drop every entry, clearing each item's link back to the board.

Definition at line 134 of file board_item_index.cpp.

References m_idsByItem, and m_itemsById.

◆ Find()

BOARD_ITEM * BOARD_ITEM_INDEX::Find ( const KIID & aId )

Return a cached item for aId if the entry is still self-consistent.

UUIDs can still be rewritten in-place in some attached-item paths. When that happens, the cache may temporarily contain a stale alias from the old UUID to the live item. Drop those aliases on read so lookups never return an item whose current UUID no longer matches the key.

Definition at line 30 of file board_item_index.cpp.

References m_itemsById, EDA_ITEM::m_Uuid, and Unbind().

Referenced by Rebind().

◆ IsIndexed() [1/2]

bool BOARD_ITEM_INDEX::IsIndexed ( const BOARD_ITEM * aItem ) const

inline

Return true if aItem is currently indexed.

This does NOT dereference the pointer, so it is safe to call even if the item has been deleted.

Definition at line 111 of file board_item_index.h.

References m_idsByItem.

◆ IsIndexed() [2/2]

bool BOARD_ITEM_INDEX::IsIndexed ( const KIID & aId ) const

inline

Return true if a forward entry for aId exists.

The entry may be stale; use Find() for a verified lookup.

Definition at line 103 of file board_item_index.h.

References m_itemsById.

◆ Rebind()

void BOARD_ITEM_INDEX::Rebind	(	BOARD_ITEM &	aItem,
		const KIID &	aNewId )

Move aItem to aNewId, keeping the index in step with the item.

Definition at line 144 of file board_item_index.cpp.

References KIID::AsString(), BindItem(), Find(), m_owner, EDA_ITEM::m_Uuid, BOARD_ITEM::SetUuidDirect(), and UnbindItem().

◆ Unbind()

void BOARD_ITEM_INDEX::Unbind ( const KIID & aId )

Remove an item from the item-by-id cache.

Definition at line 90 of file board_item_index.cpp.

References m_idsByItem, m_itemsById, and BOARD_ITEM::m_owningIndex.

Referenced by Find().

◆ UnbindChildren()

void BOARD_ITEM_INDEX::UnbindChildren ( const BOARD_ITEM & aParent )

Definition at line 205 of file board_item_index.cpp.

References NO_RECURSE, BOARD_ITEM::RunOnChildren(), and UnbindSubtree().

◆ UnbindItem()

void BOARD_ITEM_INDEX::UnbindItem ( const BOARD_ITEM & aItem )

Drop aItem itself.

Pointer-keyed, so a temporary copy sharing its UUID is left alone, and safe to call from ~BOARD_ITEM and the UUID rebind paths.

Definition at line 110 of file board_item_index.cpp.

References m_idsByItem, m_itemsById, and BOARD_ITEM::m_owningIndex.

Referenced by BindItem(), Rebind(), and UnbindSubtree().

◆ UnbindSubtree()

void BOARD_ITEM_INDEX::UnbindSubtree ( const BOARD_ITEM & aItem )

Definition at line 190 of file board_item_index.cpp.

References NO_RECURSE, BOARD_ITEM::RunOnChildren(), UnbindItem(), and UnbindSubtree().

Referenced by UnbindChildren(), and UnbindSubtree().

Member Data Documentation

◆ m_idsByItem

std::unordered_map<const BOARD_ITEM*, KIID> BOARD_ITEM_INDEX::m_idsByItem

private

Reverse map from board items to their KIIDs.

Definition at line 120 of file board_item_index.h.

Referenced by BindItem(), Clear(), IsIndexed(), Unbind(), and UnbindItem().

◆ m_itemsById

std::unordered_map<KIID, BOARD_ITEM*> BOARD_ITEM_INDEX::m_itemsById

private

Forward map from KIIDs to board items.

Definition at line 117 of file board_item_index.h.

Referenced by BindItem(), Clear(), Find(), IsIndexed(), Unbind(), and UnbindItem().

◆ m_owner

BOARD& BOARD_ITEM_INDEX::m_owner

private

Definition at line 114 of file board_item_index.h.

Referenced by BindItem(), BOARD_ITEM_INDEX(), and Rebind().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BOARD_ITEM_INDEX()

Member Function Documentation

◆ BindChildren()

◆ BindItem()

◆ BindSubtree()

◆ Clear()

◆ Find()

◆ IsIndexed() [1/2]

◆ IsIndexed() [2/2]

◆ Rebind()

◆ Unbind()

◆ UnbindChildren()

◆ UnbindItem()

◆ UnbindSubtree()

Member Data Documentation

◆ m_idsByItem

◆ m_itemsById

◆ m_owner