Main-thread extraction cache. More...

#include <conn_inputs.h>

Classes
struct	INSTANCE_INPUT

struct	ISLAND_LESS

Public Types
using	SOURCE_KEY = std::pair<SCREEN_ID, KIID>

using	SCREEN_CACHE = CACHE_TABLE<SCREEN_ID, SCREEN_FACTS>

using	FACT_CACHE = CACHE_TABLE<SOURCE_KEY, ITEM_FACT>

using	INSTANCE_CACHE = CACHE_TABLE<INST_ID, INSTANCE_FACTS>

using	TEXT_CACHE = CACHE_TABLE<ITEM_KEY, ITEM_TEXT_FACT, KEY_LESS>

using	AREA_CACHE = CACHE_TABLE<ITEM_KEY, INSTANCE_RULE_AREA_FACT, KEY_LESS>

using	UNIT_SIGNATURE = std::vector<std::pair<KIID, int>>

using	ISLAND_KEY = std::pair<SCREEN_ID, UNIT_SIGNATURE>

using	UNIT_VIEW = std::span<const std::pair<KIID, int>>

using	ISLAND_LOOKUP = std::pair<SCREEN_ID, UNIT_VIEW>

using	GEOMETRY_CACHE = CACHE_TABLE<SCREEN_ID, SCREEN_GEOMETRY>

using	ISLAND_CACHE = CACHE_TABLE<ISLAND_KEY, SCREEN_ISLANDS, ISLAND_LESS>

Public Member Functions
	INPUT_STORE (CACHE_VERSIONS &aVersions, SESSION_KEYS &aKeys)

std::vector< FRAME_INSTANCE >	Capture (const SCH_SHEET_LIST &aPaths, uint64_t aTextEpoch)

bool	ExternalSourcesChanged (const SCH_SHEET_LIST &aPaths, bool aContextUnchanged=false) const
	Compare retained external inputs for current instance/screen pairs, excluding model/revision changes.

const SCREEN_CACHE::ENTRY &	Screen (const SCH_SCREEN &aScreen)

const INSTANCE_CACHE::ENTRY &	Instance (const SCH_SCREEN &aScreen, const SCH_SHEET_PATH &aPath, uint64_t aTextEpoch)

const FACT_CACHE::ENTRY *	Fact (const SOURCE_KEY &aKey) const

const TEXT_CACHE::ENTRY *	Text (const ITEM_KEY &aKey) const

const AREA_CACHE::ENTRY *	Area (const ITEM_KEY &aKey) const

const SCREEN_CACHE::ENTRY *	FindScreen (SCREEN_ID aScreen) const

const INSTANCE_CACHE::ENTRY *	FindInstance (INST_ID aInstance) const

const INSTANCE_CACHE &	Instances () const

SCREEN_ID	InstanceScreen (INST_ID aInstance) const

const SCREEN_FACTS &	InstanceScreenFacts (INST_ID aInstance) const

const GEOMETRY_CACHE::ENTRY &	Geometry (SCREEN_ID aScreen)

const ISLAND_CACHE::ENTRY &	Islands (SCREEN_ID aScreen, const UNIT_SIGNATURE &aUnits)

const ISLAND_CACHE::ENTRY *	FindIslands (SCREEN_ID aScreen, UNIT_VIEW aUnits) const

const std::map< SCREEN_ID, uint64_t > &	ScreenRevisions () const

std::optional< std::pair< SCREEN_ID, uint64_t > >	VerifiedSymbolSource (SCREEN_ID aScreen) const

const TEXT_EVAL::ENVIRONMENT::SOURCE_VALUES *	Sources (INST_ID aInstance) const

void	Retain (const std::set< SCREEN_ID > &aScreens, const std::set< INST_ID > &aInstances)

void	Invalidate ()
	Force fresh extraction and geometry, retaining primitive values only for change comparison.

void	Clear ()

Private Member Functions
const SCREEN_CACHE::ENTRY &	storeScreen (const SCH_SCREEN &aScreen, SCREEN_FACTS aFacts)

Private Attributes
SESSION_KEYS &	m_keys

SCREEN_CACHE	m_screens

FACT_CACHE	m_facts

INSTANCE_CACHE	m_instances

TEXT_CACHE	m_text

AREA_CACHE	m_areas

GEOMETRY_CACHE	m_geometry

ISLAND_CACHE	m_islands

std::map< SCREEN_ID, uint64_t >	m_geometryInputs

std::map< ISLAND_KEY, uint64_t, ISLAND_LESS >	m_islandInputs

std::map< SCREEN_ID, uint64_t >	m_screenRevisions

std::map< SCREEN_ID, uint64_t >	m_symbolRevisions

std::map< INST_ID, INSTANCE_INPUT >	m_instanceInputs

std::map< INST_ID, TEXT_EVAL::ENVIRONMENT::SOURCE_VALUES >	m_instanceSources

Detailed Description

Main-thread extraction cache.

Returned entries follow CACHE_TABLE's reference lifetime.

See also: Schematic Connectivity Engine

Definition at line 40 of file conn_inputs.h.

Member Typedef Documentation

◆ AREA_CACHE

using SCH_CONNECTIVITY::INPUT_STORE::AREA_CACHE = CACHE_TABLE<ITEM_KEY, INSTANCE_RULE_AREA_FACT, KEY_LESS>

Definition at line 48 of file conn_inputs.h.

◆ FACT_CACHE

using SCH_CONNECTIVITY::INPUT_STORE::FACT_CACHE = CACHE_TABLE<SOURCE_KEY, ITEM_FACT>

Definition at line 45 of file conn_inputs.h.

◆ GEOMETRY_CACHE

using SCH_CONNECTIVITY::INPUT_STORE::GEOMETRY_CACHE = CACHE_TABLE<SCREEN_ID, SCREEN_GEOMETRY>

Definition at line 68 of file conn_inputs.h.

◆ INSTANCE_CACHE

using SCH_CONNECTIVITY::INPUT_STORE::INSTANCE_CACHE = CACHE_TABLE<INST_ID, INSTANCE_FACTS>

Definition at line 46 of file conn_inputs.h.

◆ ISLAND_CACHE

using SCH_CONNECTIVITY::INPUT_STORE::ISLAND_CACHE = CACHE_TABLE<ISLAND_KEY, SCREEN_ISLANDS, ISLAND_LESS>

Definition at line 69 of file conn_inputs.h.

◆ ISLAND_KEY

using SCH_CONNECTIVITY::INPUT_STORE::ISLAND_KEY = std::pair<SCREEN_ID, UNIT_SIGNATURE>

Definition at line 50 of file conn_inputs.h.

◆ ISLAND_LOOKUP

using SCH_CONNECTIVITY::INPUT_STORE::ISLAND_LOOKUP = std::pair<SCREEN_ID, UNIT_VIEW>

Definition at line 52 of file conn_inputs.h.

◆ SCREEN_CACHE

using SCH_CONNECTIVITY::INPUT_STORE::SCREEN_CACHE = CACHE_TABLE<SCREEN_ID, SCREEN_FACTS>

Definition at line 44 of file conn_inputs.h.

◆ SOURCE_KEY

using SCH_CONNECTIVITY::INPUT_STORE::SOURCE_KEY = std::pair<SCREEN_ID, KIID>

Definition at line 43 of file conn_inputs.h.

◆ TEXT_CACHE

using SCH_CONNECTIVITY::INPUT_STORE::TEXT_CACHE = CACHE_TABLE<ITEM_KEY, ITEM_TEXT_FACT, KEY_LESS>

Definition at line 47 of file conn_inputs.h.

◆ UNIT_SIGNATURE

using SCH_CONNECTIVITY::INPUT_STORE::UNIT_SIGNATURE = std::vector<std::pair<KIID, int>>

Definition at line 49 of file conn_inputs.h.

◆ UNIT_VIEW

using SCH_CONNECTIVITY::INPUT_STORE::UNIT_VIEW = std::span<const std::pair<KIID, int>>

Definition at line 51 of file conn_inputs.h.

Constructor & Destructor Documentation

◆ INPUT_STORE()

SCH_CONNECTIVITY::INPUT_STORE::INPUT_STORE	(	CACHE_VERSIONS &	aVersions,
		SESSION_KEYS &	aKeys )

Definition at line 71 of file conn_inputs.cpp.

References m_areas, m_facts, m_geometry, m_instances, m_islands, m_keys, m_screens, and m_text.

Member Function Documentation

◆ Area()

const AREA_CACHE::ENTRY * SCH_CONNECTIVITY::INPUT_STORE::Area ( const ITEM_KEY & aKey ) const

inline

Definition at line 93 of file conn_inputs.h.

References m_areas.

Referenced by SCH_CONNECTIVITY::AUXILIARY::Update().

◆ Capture()

std::vector< FRAME_INSTANCE > SCH_CONNECTIVITY::INPUT_STORE::Capture	(	const SCH_SHEET_LIST &	aPaths,
		uint64_t	aTextEpoch )

Definition at line 345 of file conn_inputs.cpp.

References SCH_CONNECTIVITY::CaptureHierarchy(), Clear(), Geometry(), Instance(), m_instances, m_islandInputs, m_islands, m_keys, SCH_CONNECTIVITY::ParallelFor(), path, and Retain().

◆ Clear()

void SCH_CONNECTIVITY::INPUT_STORE::Clear ( )

Definition at line 432 of file conn_inputs.cpp.

References Invalidate(), m_areas, m_facts, m_instances, m_screens, and m_text.

Referenced by Capture(), Geometry(), Instance(), Islands(), and storeScreen().

◆ ExternalSourcesChanged()

bool SCH_CONNECTIVITY::INPUT_STORE::ExternalSourcesChanged	(	const SCH_SHEET_LIST &	aPaths,
		bool	aContextUnchanged = false ) const

Compare retained external inputs for current instance/screen pairs, excluding model/revision changes.

Run outside SOURCE_SCOPE collection in a fresh text frame for each update, keeping that frame alive through the following Capture. Reads populate its cache; reusing an older frame retains older values. Without an active frame, this call owns one. Clock consultations can change on every fresh frame. If the caller has compared global text context, unchanged screen revisions can skip reference replay.

Definition at line 83 of file conn_inputs.cpp.

References SCH_SCREEN::ConnectivityId(), SCH_SCREEN::ConnectivityRevision(), TEXT_EVAL::ENVIRONMENT::Current(), TEXT_EVAL::ENVIRONMENT::CurrentTime(), KIGIT::PROJECT_GIT_UTILS::GetCurrentHash(), PROJECT::GetProjectPath(), TEXT_EVAL::ENVIRONMENT::GitHash(), SCHEMATIC::IsValid(), m_instanceInputs, m_keys, m_screenRevisions, name, path, SCHEMATIC::Project(), TEXT_EVAL_VCS::ReadSource(), SCHEMATIC::ResolveCrossReference(), Sources(), text, and TEXT_EVAL::ENVIRONMENT::VcsValue().

◆ Fact()

const FACT_CACHE::ENTRY * SCH_CONNECTIVITY::INPUT_STORE::Fact ( const SOURCE_KEY & aKey ) const

inline

Definition at line 91 of file conn_inputs.h.

References m_facts.

Referenced by SCH_CONNECTIVITY::AUXILIARY::Update().

◆ FindInstance()

const INSTANCE_CACHE::ENTRY * SCH_CONNECTIVITY::INPUT_STORE::FindInstance ( INST_ID aInstance ) const

inline

Definition at line 95 of file conn_inputs.h.

References m_instances.

Referenced by SCH_CONNECTIVITY::AUXILIARY::Update(), and SCH_CONNECTIVITY::RECORD_STORE::Update().

◆ FindIslands()

const ISLAND_CACHE::ENTRY * SCH_CONNECTIVITY::INPUT_STORE::FindIslands	(	SCREEN_ID	aScreen,
		UNIT_VIEW	aUnits ) const

inline

Definition at line 108 of file conn_inputs.h.

References m_islands.

Referenced by SCH_CONNECTIVITY::AUXILIARY::Update().

◆ FindScreen()

const SCREEN_CACHE::ENTRY * SCH_CONNECTIVITY::INPUT_STORE::FindScreen ( SCREEN_ID aScreen ) const

inline

Definition at line 94 of file conn_inputs.h.

References m_screens.

Referenced by SCH_CONNECTIVITY::AUXILIARY::Update(), and SCH_CONNECTIVITY::RECORD_STORE::Update().

◆ Geometry()

const INPUT_STORE::GEOMETRY_CACHE::ENTRY & SCH_CONNECTIVITY::INPUT_STORE::Geometry ( SCREEN_ID aScreen )

Definition at line 290 of file conn_inputs.cpp.

References Clear(), SCH_CONNECTIVITY::GeometryOf(), m_geometry, m_geometryInputs, m_screens, and result.

Referenced by Capture(), and Islands().

◆ Instance()

const INPUT_STORE::INSTANCE_CACHE::ENTRY & SCH_CONNECTIVITY::INPUT_STORE::Instance	(	const SCH_SCREEN &	aScreen,
		const SCH_SHEET_PATH &	aPath,
		uint64_t	aTextEpoch )