Bridges SCHEMATIC's listener stream into the generic TEXT_VAR_TRACKER. More...

#include <schematic_text_var_adapter.h>

Inheritance diagram for SCHEMATIC_TEXT_VAR_ADAPTER:

Public Member Functions
	SCHEMATIC_TEXT_VAR_ADAPTER (SCHEMATIC &aSchematic)

	~SCHEMATIC_TEXT_VAR_ADAPTER () override=default

TEXT_VAR_TRACKER &	Tracker ()

const TEXT_VAR_TRACKER &	Tracker () const

void	OnSchItemsAdded (SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aItems) override

void	OnSchItemsRemoved (SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aItems) override

void	OnSchItemsChanged (SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aItems) override

void	RebuildIndex ()
	Walk every sheet in the hierarchy and register text-bearing items.

void	SyncToHierarchy ()
	Rebuild only if a sheet was added or removed, or the set of screens in the hierarchy differs from the indexed one.

void	MarkHierarchyChanged ()
	Force the next SyncToHierarchy() to rebuild.

std::vector< TEXT_VAR_REF_KEY >	ExtractSourceKeys (EDA_ITEM *aItem) const
	Return the keys `aItem` could source as a cross-reference target.

virtual void	OnSchSheetChanged (SCHEMATIC &aSch)

virtual void	OnSchSelectionChanged (SCHEMATIC &aSch)

Private Member Functions
std::set< SCH_SCREEN * >	hierarchyScreens () const

void	noteSheets (const std::vector< SCH_ITEM * > &aItems)

std::vector< TEXT_VAR_REF_KEY >	trackKeys (SCH_ITEM *aItem)

void	registerItem (SCH_ITEM *aItem)

void	handleItemChanged (SCH_ITEM *aItem)

Static Private Member Functions
static SCH_ITEM *	trackedItem (SCH_ITEM *aItem)

static std::vector< TEXT_VAR_REF_KEY >	collectKeys (SCH_ITEM *aItem)

Private Attributes
SCHEMATIC &	m_schematic

TEXT_VAR_TRACKER	m_tracker

std::unordered_set< SCH_ITEM * >	m_registered

std::set< SCH_SCREEN * >	m_indexedScreens

bool	m_hierarchyChanged = false

Detailed Description

Bridges SCHEMATIC's listener stream into the generic TEXT_VAR_TRACKER.

Mirrors BOARD_TEXT_VAR_ADAPTER but for schematic items. A SCH_SYMBOL can carry multiple instance-specific references (different refdes on different SCH_SHEET_PATH instances), so cross-ref sources are emitted for every instance the symbol lives on.

Definition at line 41 of file schematic_text_var_adapter.h.

Constructor & Destructor Documentation

◆ SCHEMATIC_TEXT_VAR_ADAPTER()

SCHEMATIC_TEXT_VAR_ADAPTER::SCHEMATIC_TEXT_VAR_ADAPTER ( SCHEMATIC & aSchematic )

explicit

Definition at line 33 of file schematic_text_var_adapter.cpp.

References ExtractSourceKeys(), m_schematic, and m_tracker.

◆ ~SCHEMATIC_TEXT_VAR_ADAPTER()

SCHEMATIC_TEXT_VAR_ADAPTER::~SCHEMATIC_TEXT_VAR_ADAPTER ( )

overridedefault

Member Function Documentation

◆ collectKeys()

std::vector< TEXT_VAR_REF_KEY > SCHEMATIC_TEXT_VAR_ADAPTER::collectKeys ( SCH_ITEM * aItem )

staticprivate

Definition at line 55 of file schematic_text_var_adapter.cpp.

References FilterTrackable(), NO_RECURSE, SCH_ITEM::RunOnChildren(), SCH_GROUP_T, text, and EDA_ITEM::Type().

Referenced by trackKeys().

◆ ExtractSourceKeys()

std::vector< TEXT_VAR_REF_KEY > SCHEMATIC_TEXT_VAR_ADAPTER::ExtractSourceKeys ( EDA_ITEM * aItem ) const

Return the keys aItem could source as a cross-reference target.

For a SCH_SYMBOL, these are one ${REFDES:*} key and one ${KIID_PATH:*} key per sheet instance. Stored text holds the KIID path form (see SCHEMATIC::ConvertRefsToKIIDs); the refdes form is what users type.

Definition at line 208 of file schematic_text_var_adapter.cpp.

References TEXT_VAR_REF_KEY::CROSS_REF, EDA_ITEM::GetParent(), SCH_SYMBOL::GetRef(), TEXT_VAR_REF_KEY::kind, m_schematic, EDA_ITEM::m_Uuid, path, and TEXT_VAR_REF_KEY::primary.

Referenced by SCHEMATIC_TEXT_VAR_ADAPTER().