The interface used by the classes that actually can load IO plugins for the different parts of KiCad and return concrete types (symbols, footprints, etc) More...

#include <library_manager.h>

Inheritance diagram for LIBRARY_MANAGER_ADAPTER:

Public Member Functions
	LIBRARY_MANAGER_ADAPTER (LIBRARY_MANAGER &aManager)
	Constructs a type-specific adapter into the library manager.

virtual	~LIBRARY_MANAGER_ADAPTER ()

LIBRARY_MANAGER &	Manager () const

virtual LIBRARY_TABLE_TYPE	Type () const =0
	The type of library table this adapter works with.

LIBRARY_TABLE *	GlobalTable () const
	Retrieves the global library table for this adapter type.

std::optional< LIBRARY_TABLE * >	ProjectTable () const
	Retrieves the project library table for this adapter type, or nullopt if one doesn't exist.

std::optional< wxString >	FindLibraryByURI (const wxString &aURI) const

std::vector< wxString >	GetLibraryNames () const
	Returns a list of library nicknames that are available (skips any that failed to load)

bool	HasLibrary (const wxString &aNickname, bool aCheckEnabled=false) const
	Test for the existence of aNickname in the library tables.

bool	DeleteLibrary (const wxString &aNickname)
	Deletes the given library from disk if it exists; returns true if deleted.

std::optional< wxString >	GetLibraryDescription (const wxString &aNickname) const

std::vector< LIBRARY_TABLE_ROW * >	Rows (LIBRARY_TABLE_SCOPE aScope=LIBRARY_TABLE_SCOPE::BOTH, bool aIncludeInvalid=false) const
	Like LIBRARY_MANAGER::Rows but filtered to the LIBRARY_TABLE_TYPE of this adapter.

std::optional< LIBRARY_TABLE_ROW * >	GetRow (const wxString &aNickname, LIBRARY_TABLE_SCOPE aScope=LIBRARY_TABLE_SCOPE::BOTH) const
	Like LIBRARY_MANAGER::GetRow but filtered to the LIBRARY_TABLE_TYPE of this adapter.

std::optional< LIBRARY_TABLE_ROW * >	FindRowByURI (const wxString &aUri, LIBRARY_TABLE_SCOPE aScope=LIBRARY_TABLE_SCOPE::BOTH) const
	Like LIBRARY_MANAGER::FindRowByURI but filtered to the LIBRARY_TABLE_TYPE of this adapter.

virtual void	ProjectChanged ()
	Notify the adapter that the active project has changed.

void	GlobalTablesChanged (std::initializer_list< LIBRARY_TABLE_TYPE > aChangedTables={})
	Notify the adapter that the global library tables have changed.

void	ProjectTablesChanged (std::initializer_list< LIBRARY_TABLE_TYPE > aChangedTables={})
	Notify the adapter that the project library tables are about to be rebuilt.

void	ProjectTablesReloaded (std::initializer_list< LIBRARY_TABLE_TYPE > aChangedTables={})
	Complements ProjectTablesChanged by erasing project-scope cache entries whose nicknames no longer appear in the rebuilt project table.

void	CheckTableRow (LIBRARY_TABLE_ROW &aRow)

void	AsyncLoad ()
	Loads all available libraries for this adapter type in the background.

virtual std::optional< LIB_STATUS >	LoadOne (LIB_DATA *aLib)=0

virtual std::optional< LIB_STATUS >	CheckLibrary (LIB_DATA *aLib)
	Validates that a library is loadable. May not necessarily load the library!

std::optional< float >	AsyncLoadProgress () const
	Returns the fraction of the libraries queued by AsyncLoad() that have been processed, or nullopt when there is nothing to report (no load has been requested since the last reset, or every library was already loaded).

void	BlockUntilLoaded ()

void	AbortAsyncLoad ()
	Aborts any async load in progress; blocks until fully done aborting.

bool	IsLibraryLoaded (const wxString &aNickname)

std::optional< LIB_STATUS >	GetLibraryStatus (const wxString &aNickname) const
	Returns the status of a loaded library, or nullopt if the library hasn't been loaded (yet)

std::vector< std::pair< wxString, LIB_STATUS > >	GetLibraryStatuses () const
	Returns a list of all library nicknames and their status (even if they failed to load)

std::vector< KI_ERROR >	GetLibraryLoadErrors () const
	Returns all library load errors as newline-separated strings for display.

void	ReloadLibraryEntry (const wxString &aNickname, LIBRARY_TABLE_SCOPE aScope=LIBRARY_TABLE_SCOPE::BOTH)
	Synchronously recreates the plugin for and reloads the given library.

std::optional< LIB_STATUS >	LoadLibraryEntry (const wxString &aNickname)
	Synchronously loads the named library to LOADED state.

virtual bool	IsWritable (const wxString &aNickname) const
	Return true if the given nickname exists and is not a read-only library.

bool	CreateLibrary (const wxString &aNickname)
	Creates the library (i.e. saves to disk) for the given row if it exists.

virtual bool	SupportsConfigurationDialog (const LIBRARY_TABLE_ROW &aRow) const
	Configuration works from the row itself, so libraries that failed to load or are not yet committed to a table can still be configured.

virtual int	ShowConfigurationDialog (const LIBRARY_TABLE_ROW &aRow, LIBRARY_TABLE_SCOPE aScope, wxWindow *aParent)
	Shows the plugin's configuration dialog for a library table row.

virtual std::optional< LIBRARY_ERROR >	LibraryError (const wxString &aNickname) const

Protected Member Functions
virtual std::map< wxString, LIB_DATA > &	globalLibs ()=0

virtual std::map< wxString, LIB_DATA > &	globalLibs () const =0

virtual std::shared_mutex &	globalLibsMutex ()=0

virtual std::shared_mutex &	globalLibsMutex () const =0

virtual void	enumerateLibrary (LIB_DATA *aLib, const wxString &aUri)=0
	Override in derived class to perform library-specific enumeration.

wxString	getUri (const LIBRARY_TABLE_ROW *aRow) const

std::optional< const LIB_DATA * >	fetchIfLoaded (const wxString &aNickname) const

std::optional< LIB_DATA * >	fetchIfLoaded (const wxString &aNickname)

LIBRARY_RESULT< LIB_DATA * >	loadIfNeeded (const wxString &aNickname)
	Fetches a loaded library, triggering a load of that library if it isn't loaded yet.

LIBRARY_RESULT< LIB_DATA * >	loadFromScope (const wxString &aNickname, LIBRARY_TABLE_SCOPE aScope, std::map< wxString, LIB_DATA > &aTarget, std::shared_mutex &aMutex)

void	evictOwnedGlobalEntries ()
	Erases this adapter's own entries (LIB_DATA::global_owner == this) from the process-wide globalLibs() cache.

void	abortLoad ()
	Aborts any async load in progress; blocks until fully done aborting.

void	resetProjectCache ()
	Aborts pending loads and resets every project-scope cache entry in place (plugin and row cleared, status returned to INVALID) while preserving the nickname keys.

virtual LIBRARY_RESULT< IO_BASE * >	createPlugin (const LIBRARY_TABLE_ROW *row)=0
	Creates a concrete plugin for the given row.

virtual IO_BASE *	plugin (const LIB_DATA *aRow)=0

Static Protected Member Functions
static std::recursive_mutex &	pluginMutex (const wxString &aNickname)
	Serializes access to a library's shared plugin instance so its single mutable cache is not raced by concurrent enumerate/load/save/delete calls from the loader pool, preview panels and tree refreshes.

Protected Attributes
LIBRARY_MANAGER &	m_manager

std::map< wxString, LIB_DATA >	m_libraries

std::shared_mutex	m_librariesMutex

std::atomic_bool	m_abort

std::vector< std::future< void > >	m_futures

std::atomic< size_t >	m_loadCount { 0 }

std::atomic< size_t >	m_loadTotal { 0 }

std::mutex	m_loadMutex

Detailed Description

The interface used by the classes that actually can load IO plugins for the different parts of KiCad and return concrete types (symbols, footprints, etc)

Definition at line 79 of file library_manager.h.

Constructor & Destructor Documentation

◆ LIBRARY_MANAGER_ADAPTER()

LIBRARY_MANAGER_ADAPTER::LIBRARY_MANAGER_ADAPTER ( LIBRARY_MANAGER & aManager )

Constructs a type-specific adapter into the library manager.

LIBRARY_MANAGER_ADAPTER.

The code for these generally resides in app-specific libraries (eeschema/pcbnew for example) rather than being in kicommon.

Parameters

aManager should usually be Pgm().GetLibraryManager() except in QA tests

Definition at line 1125 of file library_manager.cpp.

References m_manager.

Referenced by DESIGN_BLOCK_LIBRARY_ADAPTER::DESIGN_BLOCK_LIBRARY_ADAPTER(), FOOTPRINT_LIBRARY_ADAPTER::FOOTPRINT_LIBRARY_ADAPTER(), and SYMBOL_LIBRARY_ADAPTER::SYMBOL_LIBRARY_ADAPTER().

◆ ~LIBRARY_MANAGER_ADAPTER()

LIBRARY_MANAGER_ADAPTER::~LIBRARY_MANAGER_ADAPTER ( )

virtual

Definition at line 1131 of file library_manager.cpp.

Member Function Documentation

◆ AbortAsyncLoad()

void LIBRARY_MANAGER_ADAPTER::AbortAsyncLoad ( )

Aborts any async load in progress; blocks until fully done aborting.

This is the public interface to allow LIBRARY_MANAGER to abort loads before project changes.

Definition at line 1170 of file library_manager.cpp.

References abortLoad().

Referenced by PGM_BASE::PreloadDesignBlockLibraries(), PCB::IFACE::PreloadLibraries(), SCH::IFACE::PreloadLibraries(), ReconcileLegacyCacheSymbols(), and SCH_SCREEN::UpdateSymbolLinks().

◆ abortLoad()

void LIBRARY_MANAGER_ADAPTER::abortLoad ( )

protected

Aborts any async load in progress; blocks until fully done aborting.

Definition at line 1454 of file library_manager.cpp.

References BlockUntilLoaded(), m_abort, m_futures, m_loadCount, m_loadMutex, m_loadTotal, and traceLibraries.

Referenced by AbortAsyncLoad(), CheckTableRow(), enumerateLibrary(), evictOwnedGlobalEntries(), GlobalTablesChanged(), ReloadLibraryEntry(), and resetProjectCache().

◆ AsyncLoad()

void LIBRARY_MANAGER_ADAPTER::AsyncLoad ( )

Loads all available libraries for this adapter type in the background.

Definition at line 1889 of file library_manager.cpp.

References GetKiCadThreadPool(), getUri(), globalLibs(), globalLibsMutex(), LOADED, LOADING, m_futures, m_libraries, m_librariesMutex, m_loadCount, m_loadMutex, m_loadTotal, m_manager, PROJECT, tp, traceLibraries, and Type().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), filterFootprints(), SCH::filterFootprintUsers(), PCB::IFACE::handleOpenFootprint(), SCH::IFACE::handleOpenSymbol(), PCBNEW_JOBS_HANDLER::JobExportDrc(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCB::IFACE::LoadAllLibraries(), SCH::IFACE::LoadAllLibraries(), API_HANDLER_LIBRARIES::loadAllLibraries(), LoadNetlistFootprints(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PGM_BASE::PreloadDesignBlockLibraries(), PCB::IFACE::PreloadLibraries(), SCH::IFACE::PreloadLibraries(), startFootprintLibraryLoad(), and SCH::startSymbolLibraryLoad().

◆ AsyncLoadProgress()

std::optional< float > LIBRARY_MANAGER_ADAPTER::AsyncLoadProgress ( ) const

Returns the fraction of the libraries queued by AsyncLoad() that have been processed, or nullopt when there is nothing to report (no load has been requested since the last reset, or every library was already loaded).

This is the non-blocking view of the load: anything other than 1.0 means a load may still be running. It reaches 1.0 once the last library has been counted, which can be a moment before the workers retire, so a path that must not stall still waits with BlockUntilLoaded().

Definition at line 1479 of file library_manager.cpp.

References m_loadCount, and m_loadTotal.

Referenced by BOOST_AUTO_TEST_CASE(), footprintLibraryLoadProgress(), SCH::kiface(), PGM_BASE::PreloadDesignBlockLibraries(), PCB::IFACE::PreloadLibraries(), and SCH::IFACE::PreloadLibraries().

◆ BlockUntilLoaded()

void LIBRARY_MANAGER_ADAPTER::BlockUntilLoaded ( )

◆ CheckLibrary()

virtual std::optional< LIB_STATUS > LIBRARY_MANAGER_ADAPTER::CheckLibrary ( LIB_DATA * aLib )

inlinevirtual

Validates that a library is loadable. May not necessarily load the library!

Reimplemented in SYMBOL_LIBRARY_ADAPTER.

Definition at line 163 of file library_manager.h.

References LoadOne().

Referenced by CheckTableRow().

◆ CheckTableRow()

void LIBRARY_MANAGER_ADAPTER::CheckTableRow ( LIBRARY_TABLE_ROW & aRow )

◆ CreateLibrary()

bool LIBRARY_MANAGER_ADAPTER::CreateLibrary ( const wxString & aNickname )

Creates the library (i.e. saves to disk) for the given row if it exists.

Definition at line 1691 of file library_manager.cpp.

References IO_BASE::CreateLibrary(), LIBRARY_TABLE_ROW::GetOptionsMap(), getUri(), loadIfNeeded(), LIB_DATA::plugin, pluginMutex(), result, LIB_DATA::row, traceLibraries, and IO_ERROR::What().

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), and SaveRemoteSymbolToLibrary().

◆ createPlugin()

virtual LIBRARY_RESULT< IO_BASE * > LIBRARY_MANAGER_ADAPTER::createPlugin ( const LIBRARY_TABLE_ROW * row )

protectedpure virtual

Creates a concrete plugin for the given row.

Implemented in DESIGN_BLOCK_LIBRARY_ADAPTER, FOOTPRINT_LIBRARY_ADAPTER, and SYMBOL_LIBRARY_ADAPTER.

Referenced by CheckTableRow(), and loadFromScope().

◆ DeleteLibrary()

bool LIBRARY_MANAGER_ADAPTER::DeleteLibrary ( const wxString & aNickname )

Deletes the given library from disk if it exists; returns true if deleted.

Definition at line 1398 of file library_manager.cpp.

References IO_BASE::DeleteLibrary(), LIBRARY_TABLE_ROW::GetOptionsMap(), getUri(), loadIfNeeded(), LIB_DATA::plugin, pluginMutex(), result, and LIB_DATA::row.

Referenced by Type().

◆ enumerateLibrary()

virtual void LIBRARY_MANAGER_ADAPTER::enumerateLibrary	(	LIB_DATA *	aLib,
		const wxString &	aUri )

protectedpure virtual

Override in derived class to perform library-specific enumeration.

Parameters

aLib
aUri	is the pre-resolved library URI (must be resolved on the main thread since URI expansion accesses PROJECT data that is not thread-safe).

Implemented in DESIGN_BLOCK_LIBRARY_ADAPTER, FOOTPRINT_LIBRARY_ADAPTER, and SYMBOL_LIBRARY_ADAPTER.

References abortLoad(), evictOwnedGlobalEntries(), fetchIfLoaded(), getUri(), loadFromScope(), loadIfNeeded(), and resetProjectCache().

◆ evictOwnedGlobalEntries()

void LIBRARY_MANAGER_ADAPTER::evictOwnedGlobalEntries ( )

protected

Erases this adapter's own entries (LIB_DATA::global_owner == this) from the process-wide globalLibs() cache.

The cached LIB_DATA::row pointers reference this manager's tables, so they must be dropped before the manager is destroyed or a later manager's fetchIfLoaded() would dereference freed rows. Derived destructors must call this while globalLibs() is still resolvable. Derived destructors must also call resetProjectCache() so plugin worker threads are joined while the derived adapter is still alive.

Definition at line 1204 of file library_manager.cpp.

References abortLoad(), globalLibs(), and globalLibsMutex().

Referenced by enumerateLibrary(), DESIGN_BLOCK_LIBRARY_ADAPTER::~DESIGN_BLOCK_LIBRARY_ADAPTER(), FOOTPRINT_LIBRARY_ADAPTER::~FOOTPRINT_LIBRARY_ADAPTER(), and SYMBOL_LIBRARY_ADAPTER::~SYMBOL_LIBRARY_ADAPTER().

◆ fetchIfLoaded() [1/2]

std::optional< LIB_DATA * > LIBRARY_MANAGER_ADAPTER::fetchIfLoaded ( const wxString & aNickname )

protected

Definition at line 1764 of file library_manager.cpp.

References find, globalLibs(), globalLibsMutex(), LOADED, m_libraries, m_librariesMutex, m_manager, PROJECT, and Type().

◆ fetchIfLoaded() [2/2]

std::optional< const LIB_DATA * > LIBRARY_MANAGER_ADAPTER::fetchIfLoaded ( const wxString & aNickname ) const

protected

Definition at line 1731 of file library_manager.cpp.

References find, globalLibs(), globalLibsMutex(), LOADED, m_libraries, m_librariesMutex, m_manager, PROJECT, and Type().

◆ FindLibraryByURI()

std::optional< wxString > LIBRARY_MANAGER_ADAPTER::FindLibraryByURI ( const wxString & aURI ) const

Definition at line 1352 of file library_manager.cpp.

References LIBRARY_MANAGER::GetFullURI(), m_manager, Type(), and LIBRARY_MANAGER::UrisAreEquivalent().

Referenced by Type().

◆ FindRowByURI()

std::optional< LIBRARY_TABLE_ROW * > LIBRARY_MANAGER_ADAPTER::FindRowByURI	(	const wxString &	aUri,
		LIBRARY_TABLE_SCOPE	aScope = LIBRARY_TABLE_SCOPE::BOTH ) const

Like LIBRARY_MANAGER::FindRowByURI but filtered to the LIBRARY_TABLE_TYPE of this adapter.

Definition at line 1446 of file library_manager.cpp.

References m_manager, and Type().

Referenced by FOOTPRINT_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), and Type().

◆ GetLibraryDescription()

std::optional< wxString > LIBRARY_MANAGER_ADAPTER::GetLibraryDescription ( const wxString & aNickname ) const

Definition at line 1423 of file library_manager.cpp.

References fetchIfLoaded().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_BASE_FRAME::GetLibraryItemsForListDialog(), SCH_BASE_FRAME::GetLibraryItemsForListDialog(), and Type().

◆ GetLibraryLoadErrors()

std::vector< KI_ERROR > LIBRARY_MANAGER_ADAPTER::GetLibraryLoadErrors ( ) const

Returns all library load errors as newline-separated strings for display.

Definition at line 1576 of file library_manager.cpp.

References _, GetLibraryStatuses(), LOAD_ERROR, and RPT_SEVERITY_ERROR.

Referenced by PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::KiwayMailIn(), PCB::IFACE::PreloadLibraries(), and SCH::IFACE::PreloadLibraries().

◆ GetLibraryNames()

std::vector< wxString > LIBRARY_MANAGER_ADAPTER::GetLibraryNames ( ) const

Returns a list of library nicknames that are available (skips any that failed to load)

Definition at line 1364 of file library_manager.cpp.

References fetchIfLoaded(), INSENSITIVE, m_manager, StrNumSort(), traceLibraries, and Type().

Referenced by BOOST_AUTO_TEST_CASE(), CVPCB_MAINFRAME::BuildLibrariesList(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DESIGN_BLOCK_LIBRARY_ADAPTER::DesignBlockLoadWithOptionalNickname(), filterFootprints(), SCH::filterFootprintUsers(), FOOTPRINT_LIBRARY_ADAPTER::GenerateTimestamp(), SYMBOL_LIBRARY_MANAGER::GetLibraryCount(), PCB_BASE_FRAME::GetLibraryItemsForListDialog(), SCH_BASE_FRAME::GetLibraryItemsForListDialog(), guessNickname(), FOOTPRINT_LIBRARY_ADAPTER::LoadFootprintWithOptionalNickname(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), FOOTPRINT_LIST_IMPL::ReadFootprintFiles(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_LIBRARY_ADAPTER::RefreshChangedLibraries(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), and Type().

◆ GetLibraryStatus()

std::optional< LIB_STATUS > LIBRARY_MANAGER_ADAPTER::GetLibraryStatus ( const wxString & aNickname ) const

Returns the status of a loaded library, or nullopt if the library hasn't been loaded (yet)

Definition at line 1869 of file library_manager.cpp.

References find, globalLibs(), globalLibsMutex(), m_libraries, and m_librariesMutex.

Referenced by GetLibraryStatuses(), API_HANDLER_LIBRARIES::handleGetLibraryStatuses(), DESIGN_BLOCK_LIBRARY_ADAPTER::libraryUnavailableMessage(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), and CV::testFootprintLink().

◆ GetLibraryStatuses()

std::vector< std::pair< wxString, LIB_STATUS > > LIBRARY_MANAGER_ADAPTER::GetLibraryStatuses ( ) const

Returns a list of all library nicknames and their status (even if they failed to load)

Definition at line 1546 of file library_manager.cpp.

References GetLibraryStatus(), INVALID, m_manager, result, and Type().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GetLibraryLoadErrors(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ GetRow()

std::optional< LIBRARY_TABLE_ROW * > LIBRARY_MANAGER_ADAPTER::GetRow	(	const wxString &	aNickname,
		LIBRARY_TABLE_SCOPE	aScope = LIBRARY_TABLE_SCOPE::BOTH ) const

Like LIBRARY_MANAGER::GetRow but filtered to the LIBRARY_TABLE_TYPE of this adapter.

Definition at line 1439 of file library_manager.cpp.

References m_manager, and Type().

Referenced by PANEL_PREVIEW_3D_MODEL::alignmentModel(), BOOST_AUTO_TEST_CASE(), EXPORTER_STEP::buildFootprint3DShapes(), FOOTPRINT_EDITOR_CONTROL::CompareLibraryWithFile(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), IDF_EXPORTER::exportFootprintIdfModels(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), BOARD_ADAPTER::GetFootprintLibraryPath(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_VIEWER_FRAME::KiwayMailIn(), DESIGN_BLOCK_LIBRARY_ADAPTER::libraryUnavailableMessage(), SCH_SYMBOL::LoadAlternateFromLibrary(), SCH_EDIT_FRAME::LoadSheetFromFile(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), SYMBOL_EDIT_FRAME::saveLibrary(), PCB_BASE_FRAME::setFPWatcher(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), Type(), SCH_SCREEN::UpdateSymbolLinks(), and PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists().

◆ getUri()

wxString LIBRARY_MANAGER_ADAPTER::getUri ( const LIBRARY_TABLE_ROW * aRow ) const

protected

Definition at line 1725 of file library_manager.cpp.

References LIBRARY_MANAGER::ExpandURI(), m_manager, and LIBRARY_TABLE_ROW::URI().

◆ globalLibs() [1/2]

virtual std::map< wxString, LIB_DATA > & LIBRARY_MANAGER_ADAPTER::globalLibs ( ) const

protectedpure virtual

Implemented in DESIGN_BLOCK_LIBRARY_ADAPTER, FOOTPRINT_LIBRARY_ADAPTER, and SYMBOL_LIBRARY_ADAPTER.

◆ globalLibs() [2/2]

virtual std::map< wxString, LIB_DATA > & LIBRARY_MANAGER_ADAPTER::globalLibs ( )

protectedpure virtual

Implemented in DESIGN_BLOCK_LIBRARY_ADAPTER, FOOTPRINT_LIBRARY_ADAPTER, and SYMBOL_LIBRARY_ADAPTER.

Referenced by AsyncLoad(), evictOwnedGlobalEntries(), fetchIfLoaded(), fetchIfLoaded(), GetLibraryStatus(), GlobalTablesChanged(), IsLibraryLoaded(), LibraryError(), loadIfNeeded(), and ReloadLibraryEntry().

◆ globalLibsMutex() [1/2]

virtual std::shared_mutex & LIBRARY_MANAGER_ADAPTER::globalLibsMutex ( ) const

protectedpure virtual

Implemented in DESIGN_BLOCK_LIBRARY_ADAPTER, FOOTPRINT_LIBRARY_ADAPTER, and SYMBOL_LIBRARY_ADAPTER.

◆ globalLibsMutex() [2/2]

virtual std::shared_mutex & LIBRARY_MANAGER_ADAPTER::globalLibsMutex ( )

protectedpure virtual

Implemented in DESIGN_BLOCK_LIBRARY_ADAPTER, FOOTPRINT_LIBRARY_ADAPTER, and SYMBOL_LIBRARY_ADAPTER.

Referenced by AsyncLoad(), evictOwnedGlobalEntries(), fetchIfLoaded(), fetchIfLoaded(), GetLibraryStatus(), GlobalTablesChanged(), IsLibraryLoaded(), LibraryError(), loadIfNeeded(), and ReloadLibraryEntry().

◆ GlobalTable()

LIBRARY_TABLE * LIBRARY_MANAGER_ADAPTER::GlobalTable ( ) const

Retrieves the global library table for this adapter type.

Definition at line 1339 of file library_manager.cpp.

References GLOBAL, m_manager, and Type().

Referenced by Type().

◆ GlobalTablesChanged()

void LIBRARY_MANAGER_ADAPTER::GlobalTablesChanged ( std::initializer_list< LIBRARY_TABLE_TYPE > aChangedTables = {} )

Notify the adapter that the global library tables have changed.

Definition at line 1176 of file library_manager.cpp.

References abortLoad(), globalLibs(), globalLibsMutex(), and Type().

Referenced by Type().

◆ HasLibrary()

bool LIBRARY_MANAGER_ADAPTER::HasLibrary	(	const wxString &	aNickname,
		bool	aCheckEnabled = false ) const

Test for the existence of aNickname in the library tables.

Parameters

aNickname	is the library nickname.
aCheckEnabled	if true will only return true for enabled libraries

Returns: true if a library aNickname exists in the loaded tables.

Definition at line 1387 of file library_manager.cpp.

References fetchIfLoaded().

Referenced by SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDIT_FRAME::addLibTableEntry(), BOOST_AUTO_TEST_CASE(), SYMBOL_VIEWER_FRAME::ClickOnLibList(), SYMBOL_EDIT_FRAME::DdAddLibrary(), BOARD_INSPECTION_TOOL::DiffFootprint(), SCH_INSPECTION_TOOL::DiffSymbol(), FOOTPRINT_LIBRARY_ADAPTER::GenerateTimestamp(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), SCH_SYMBOL::LoadAlternateFromLibrary(), SCH_EDIT_FRAME::LoadSheetFromFile(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), SYMBOL_EDIT_FRAME::saveLibrary(), SCH_BASE_FRAME::SelectLibrary(), CV::testFootprintLink(), Type(), and SCH_SCREEN::UpdateSymbolLinks().

◆ IsLibraryLoaded()

bool LIBRARY_MANAGER_ADAPTER::IsLibraryLoaded ( const wxString & aNickname )

Definition at line 1506 of file library_manager.cpp.

References find, globalLibs(), globalLibsMutex(), LOADED, m_libraries, and m_librariesMutex.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SYMBOL_LIBRARY_MANAGER::IsLibraryLoaded(), loadLibrary(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), and ERC_TESTER::TestLibSymbolIssues().

◆ IsWritable()

bool LIBRARY_MANAGER_ADAPTER::IsWritable ( const wxString & aNickname ) const

virtual

Return true if the given nickname exists and is not a read-only library.

Definition at line 1674 of file library_manager.cpp.

References fetchIfLoaded(), getUri(), IO_BASE::IsLibraryWritable(), LIB_DATA::plugin, pluginMutex(), result, and LIB_DATA::row.

◆ LibraryError()

std::optional< LIBRARY_ERROR > LIBRARY_MANAGER_ADAPTER::LibraryError ( const wxString & aNickname ) const

virtual

Definition at line 1526 of file library_manager.cpp.

References find, globalLibs(), globalLibsMutex(), m_libraries, and m_librariesMutex.

Referenced by LIB_TABLE_GRID_TRICKS::onGridCellLeftClick().

◆ loadFromScope()

LIBRARY_RESULT< LIB_DATA * > LIBRARY_MANAGER_ADAPTER::loadFromScope	(	const wxString &	aNickname,
		LIBRARY_TABLE_SCOPE	aScope,
		std::map< wxString, LIB_DATA > &	aTarget,
		std::shared_mutex &	aMutex )

protected

Definition at line 1797 of file library_manager.cpp.

References createPlugin(), GLOBAL, LIB_DATA::global_owner, LIB_STATUS::load_status, LOADING, m_manager, LIBRARY_TABLE_ROW::Nickname(), LIB_DATA::plugin, plugin(), result, LIB_DATA::row, LIB_DATA::status, traceLibraries, and Type().

Referenced by enumerateLibrary(), loadIfNeeded(), and ReloadLibraryEntry().

◆ loadIfNeeded()

LIBRARY_RESULT< LIB_DATA * > LIBRARY_MANAGER_ADAPTER::loadIfNeeded ( const wxString & aNickname )

protected

Fetches a loaded library, triggering a load of that library if it isn't loaded yet.

Definition at line 1851 of file library_manager.cpp.

References _, GLOBAL, globalLibs(), globalLibsMutex(), loadFromScope(), m_libraries, m_librariesMutex, PROJECT, and result.

Referenced by CreateLibrary(), DeleteLibrary(), SYMBOL_LIBRARY_ADAPTER::DeleteSymbol(), enumerateLibrary(), LoadLibraryEntry(), DESIGN_BLOCK_LIBRARY_ADAPTER::LoadOne(), FOOTPRINT_LIBRARY_ADAPTER::LoadOne(), SYMBOL_LIBRARY_ADAPTER::LoadOne(), and SYMBOL_LIBRARY_ADAPTER::SaveSymbol().

◆ LoadLibraryEntry()

std::optional< LIB_STATUS > LIBRARY_MANAGER_ADAPTER::LoadLibraryEntry ( const wxString & aNickname )

Synchronously loads the named library to LOADED state.

Returns the resulting status, or nullopt if the library is not found in any table.

Definition at line 1600 of file library_manager.cpp.

References loadIfNeeded(), LoadOne(), and result.

Referenced by API_HANDLER_LIBRARIES::handleGetItemsFromLibrary(), API_HANDLER_LIBRARIES::handleGetLibraryItems(), and loadLibrary().

◆ LoadOne()

virtual std::optional< LIB_STATUS > LIBRARY_MANAGER_ADAPTER::LoadOne ( LIB_DATA * aLib )

pure virtual

Implemented in DESIGN_BLOCK_LIBRARY_ADAPTER, FOOTPRINT_LIBRARY_ADAPTER, and SYMBOL_LIBRARY_ADAPTER.

Referenced by CheckLibrary(), LoadLibraryEntry(), and ReloadLibraryEntry().

◆ Manager()

LIBRARY_MANAGER & LIBRARY_MANAGER_ADAPTER::Manager ( ) const

Definition at line 1136 of file library_manager.cpp.

References m_manager.

◆ plugin()

virtual IO_BASE * LIBRARY_MANAGER_ADAPTER::plugin ( const LIB_DATA * aRow )

protectedpure virtual

Implemented in DESIGN_BLOCK_LIBRARY_ADAPTER, FOOTPRINT_LIBRARY_ADAPTER, and SYMBOL_LIBRARY_ADAPTER.

References pluginMutex().

Referenced by CheckTableRow(), and loadFromScope().

◆ pluginMutex()

std::recursive_mutex & LIBRARY_MANAGER_ADAPTER::pluginMutex ( const wxString & aNickname )

staticprotected

Serializes access to a library's shared plugin instance so its single mutable cache is not raced by concurrent enumerate/load/save/delete calls from the loader pool, preview panels and tree refreshes.

Keyed by nickname, a safe over-approximation of the real resource (the plugin instance): sharing one mutex across two distinct resources can only over-serialize, never under-protect. Static because global-library plugins are shared process-wide. Recursive because database/http libraries resolve references back through the adapter into other plugins' LoadSymbol paths while already holding their own mutex.

Definition at line 53 of file library_manager.cpp.

Referenced by SYMBOL_LIBRARY_ADAPTER::CheckLibrary(), CreateLibrary(), FOOTPRINT_LIBRARY_ADAPTER::DeleteFootprint(), DeleteLibrary(), SYMBOL_LIBRARY_ADAPTER::DeleteSymbol(), DESIGN_BLOCK_LIBRARY_ADAPTER::DesignBlockExists(), FOOTPRINT_LIBRARY_ADAPTER::enumerateLibrary(), SYMBOL_LIBRARY_ADAPTER::enumerateLibrary(), FOOTPRINT_LIBRARY_ADAPTER::FootprintExists(), FOOTPRINT_LIBRARY_ADAPTER::GetFootprintNames(), SYMBOL_LIBRARY_ADAPTER::GetSymbolNames(), SYMBOL_LIBRARY_ADAPTER::GetSymbols(), FOOTPRINT_LIBRARY_ADAPTER::IsFootprintLibWritable(), IsWritable(), DESIGN_BLOCK_LIBRARY_ADAPTER::LoadDesignBlock(), FOOTPRINT_LIBRARY_ADAPTER::LoadFootprint(), SYMBOL_LIBRARY_ADAPTER::LoadOne(), SYMBOL_LIBRARY_ADAPTER::LoadSymbol(), plugin(), FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint(), and SYMBOL_LIBRARY_ADAPTER::SaveSymbol().

◆ ProjectChanged()

void LIBRARY_MANAGER_ADAPTER::ProjectChanged ( )

virtual

Notify the adapter that the active project has changed.

Definition at line 1142 of file library_manager.cpp.

References resetProjectCache().

◆ ProjectTable()

std::optional< LIBRARY_TABLE * > LIBRARY_MANAGER_ADAPTER::ProjectTable ( ) const

Retrieves the project library table for this adapter type, or nullopt if one doesn't exist.

Definition at line 1346 of file library_manager.cpp.

References m_manager, PROJECT, and Type().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_EDIT_FRAME::OpenProjectFiles(), and Type().

◆ ProjectTablesChanged()

void LIBRARY_MANAGER_ADAPTER::ProjectTablesChanged ( std::initializer_list< LIBRARY_TABLE_TYPE > aChangedTables = {} )

Notify the adapter that the project library tables are about to be rebuilt.

Mirrors GlobalTablesChanged: aborts any in-progress loads and invalidates cached LIB_DATA entries so raw LIBRARY_TABLE_ROW pointers do not dangle when the backing LIBRARY_TABLE objects are destroyed and rebuilt. Entries are reset in place (rather than erased) so their nicknames continue to mask same-named global libraries until the project scope is repopulated.

Definition at line 1224 of file library_manager.cpp.

References resetProjectCache(), and Type().

◆ ProjectTablesReloaded()

void LIBRARY_MANAGER_ADAPTER::ProjectTablesReloaded ( std::initializer_list< LIBRARY_TABLE_TYPE > aChangedTables = {} )

Complements ProjectTablesChanged by erasing project-scope cache entries whose nicknames no longer appear in the rebuilt project table.

Must be called AFTER the new project table is loaded; otherwise removed libraries would be permanently masked by stale sentinels installed during the reset.

Definition at line 1244 of file library_manager.cpp.

References m_libraries, m_librariesMutex, m_manager, PROJECT, and Type().

◆ ReloadLibraryEntry()

void LIBRARY_MANAGER_ADAPTER::ReloadLibraryEntry	(	const wxString &	aNickname,
		LIBRARY_TABLE_SCOPE	aScope = LIBRARY_TABLE_SCOPE::BOTH )

Synchronously recreates the plugin for and reloads the given library.

Definition at line 1611 of file library_manager.cpp.

References abortLoad(), BOTH, GLOBAL, globalLibs(), globalLibsMutex(), loadFromScope(), LoadOne(), m_libraries, m_librariesMutex, PROJECT, result, traceLibraries, and UNINITIALIZED.

Referenced by SCH_IO_EAGLE::LoadSchematicFile(), and SYMBOL_LIBRARY_ADAPTER::ShowConfigurationDialog().

◆ resetProjectCache()

void LIBRARY_MANAGER_ADAPTER::resetProjectCache ( )

protected

Aborts pending loads and resets every project-scope cache entry in place (plugin and row cleared, status returned to INVALID) while preserving the nickname keys.

Keeping the keys acts as a sentinel: fetchIfLoaded() finds the entry, sees it is no longer LOADED, and returns nullopt instead of falling through to globalLibs(), which is what preserves project-over- global shadowing across a project table reload. Shared between ProjectChanged() and ProjectTablesChanged() so both hooks stay in sync.

Definition at line 1148 of file library_manager.cpp.

References abortLoad(), m_libraries, and m_librariesMutex.

Referenced by enumerateLibrary(), ProjectChanged(), ProjectTablesChanged(), DESIGN_BLOCK_LIBRARY_ADAPTER::~DESIGN_BLOCK_LIBRARY_ADAPTER(), FOOTPRINT_LIBRARY_ADAPTER::~FOOTPRINT_LIBRARY_ADAPTER(), and SYMBOL_LIBRARY_ADAPTER::~SYMBOL_LIBRARY_ADAPTER().

◆ Rows()

std::vector< LIBRARY_TABLE_ROW * > LIBRARY_MANAGER_ADAPTER::Rows	(	LIBRARY_TABLE_SCOPE	aScope = LIBRARY_TABLE_SCOPE::BOTH,
		bool	aIncludeInvalid = false ) const

Like LIBRARY_MANAGER::Rows but filtered to the LIBRARY_TABLE_TYPE of this adapter.

Definition at line 1432 of file library_manager.cpp.

References m_manager, and Type().

Referenced by API_HANDLER_LIBRARIES::handleGetLibraryItems(), DESIGN_BLOCK_LIBRARY_ADAPTER::libraryUnavailableMessage(), CVPCB_MAINFRAME::LoadFootprintFiles(), LoadNetlistFootprints(), ReconcileLegacyCacheSymbols(), and Type().

◆ ShowConfigurationDialog()

virtual int LIBRARY_MANAGER_ADAPTER::ShowConfigurationDialog	(	const LIBRARY_TABLE_ROW &	aRow,
		LIBRARY_TABLE_SCOPE	aScope,
		wxWindow *	aParent )

inlinevirtual

Shows the plugin's configuration dialog for a library table row.

On OK, the committed library with the same nickname, type and URI in aScope is reloaded.

Reimplemented in SYMBOL_LIBRARY_ADAPTER.

Definition at line 216 of file library_manager.h.

Referenced by LIB_TABLE_GRID_TRICKS::doPopupSelection(), and LIB_TABLE_GRID_TRICKS::onGridCellLeftClick().

◆ SupportsConfigurationDialog()

virtual bool LIBRARY_MANAGER_ADAPTER::SupportsConfigurationDialog ( const LIBRARY_TABLE_ROW & aRow ) const

inlinevirtual

Configuration works from the row itself, so libraries that failed to load or are not yet committed to a table can still be configured.

Reimplemented in SYMBOL_LIBRARY_ADAPTER.

Definition at line 210 of file library_manager.h.

Referenced by LIB_TABLE_GRID_TRICKS::onGridCellLeftClick().

◆ Type()

virtual LIBRARY_TABLE_TYPE LIBRARY_MANAGER_ADAPTER::Type ( ) const

pure virtual

The type of library table this adapter works with.

Implemented in DESIGN_BLOCK_LIBRARY_ADAPTER, FOOTPRINT_LIBRARY_ADAPTER, and SYMBOL_LIBRARY_ADAPTER.

References BOTH, DeleteLibrary(), FindLibraryByURI(), FindRowByURI(), GetLibraryDescription(), GetLibraryNames(), GetRow(), GlobalTable(), GlobalTablesChanged(), HasLibrary(), ProjectTable(), and Rows().

Referenced by AsyncLoad(), fetchIfLoaded(), fetchIfLoaded(), FindLibraryByURI(), FindRowByURI(), GetLibraryNames(), GetLibraryStatuses(), GetRow(), GlobalTable(), GlobalTablesChanged(), loadFromScope(), ProjectTable(), ProjectTablesChanged(), ProjectTablesReloaded(), and Rows().

Member Data Documentation

◆ m_abort

std::atomic_bool LIBRARY_MANAGER_ADAPTER::m_abort

protected

Definition at line 293 of file library_manager.h.

Referenced by abortLoad().

◆ m_futures

std::vector<std::future<void> > LIBRARY_MANAGER_ADAPTER::m_futures

protected

Definition at line 294 of file library_manager.h.

Referenced by abortLoad(), AsyncLoad(), and BlockUntilLoaded().

◆ m_libraries

std::map<wxString, LIB_DATA> LIBRARY_MANAGER_ADAPTER::m_libraries

protected

Definition at line 289 of file library_manager.h.

Referenced by AsyncLoad(), fetchIfLoaded(), fetchIfLoaded(), GetLibraryStatus(), IsLibraryLoaded(), LibraryError(), loadIfNeeded(), ProjectTablesReloaded(), ReloadLibraryEntry(), and resetProjectCache().

◆ m_librariesMutex

std::shared_mutex LIBRARY_MANAGER_ADAPTER::m_librariesMutex

mutableprotected

Definition at line 291 of file library_manager.h.

Referenced by AsyncLoad(), fetchIfLoaded(), fetchIfLoaded(), GetLibraryStatus(), IsLibraryLoaded(), LibraryError(), loadIfNeeded(), ProjectTablesReloaded(), ReloadLibraryEntry(), and resetProjectCache().

◆ m_loadCount

std::atomic<size_t> LIBRARY_MANAGER_ADAPTER::m_loadCount { 0 }

protected

Definition at line 296 of file library_manager.h.

Referenced by abortLoad(), AsyncLoad(), AsyncLoadProgress(), and BlockUntilLoaded().

◆ m_loadMutex

std::mutex LIBRARY_MANAGER_ADAPTER::m_loadMutex

protected

Definition at line 298 of file library_manager.h.

Referenced by abortLoad(), AsyncLoad(), and BlockUntilLoaded().

◆ m_loadTotal

std::atomic<size_t> LIBRARY_MANAGER_ADAPTER::m_loadTotal { 0 }

protected

Definition at line 297 of file library_manager.h.

Referenced by abortLoad(), AsyncLoad(), AsyncLoadProgress(), and BlockUntilLoaded().

◆ m_manager

LIBRARY_MANAGER& LIBRARY_MANAGER_ADAPTER::m_manager

protected

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LIBRARY_MANAGER_ADAPTER()

◆ ~LIBRARY_MANAGER_ADAPTER()

Member Function Documentation

◆ AbortAsyncLoad()

◆ abortLoad()

◆ AsyncLoad()

◆ AsyncLoadProgress()

◆ BlockUntilLoaded()

◆ CheckLibrary()

◆ CheckTableRow()

◆ CreateLibrary()

◆ createPlugin()

◆ DeleteLibrary()

◆ enumerateLibrary()

◆ evictOwnedGlobalEntries()

◆ fetchIfLoaded() [1/2]

◆ fetchIfLoaded() [2/2]

◆ FindLibraryByURI()

◆ FindRowByURI()

◆ GetLibraryDescription()

◆ GetLibraryLoadErrors()

◆ GetLibraryNames()

◆ GetLibraryStatus()

◆ GetLibraryStatuses()

◆ GetRow()

◆ getUri()

◆ globalLibs() [1/2]

◆ globalLibs() [2/2]

◆ globalLibsMutex() [1/2]

◆ globalLibsMutex() [2/2]

◆ GlobalTable()

◆ GlobalTablesChanged()

◆ HasLibrary()

◆ IsLibraryLoaded()

◆ IsWritable()

◆ LibraryError()

◆ loadFromScope()

◆ loadIfNeeded()

◆ LoadLibraryEntry()

◆ LoadOne()

◆ Manager()

◆ plugin()

◆ pluginMutex()

◆ ProjectChanged()

◆ ProjectTable()

◆ ProjectTablesChanged()

◆ ProjectTablesReloaded()

◆ ReloadLibraryEntry()

◆ resetProjectCache()

◆ Rows()

◆ ShowConfigurationDialog()

◆ SupportsConfigurationDialog()

◆ Type()

Member Data Documentation

◆ m_abort

◆ m_futures

◆ m_libraries

◆ m_librariesMutex

◆ m_loadCount

◆ m_loadMutex

◆ m_loadTotal

◆ m_manager