KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Private Member Functions | Static Private Attributes | List of all members
FOOTPRINT_LIBRARY_ADAPTER Class Reference

An interface to the global shared library manager that is schematic-specific and linked to one project in particular. More...

#include <footprint_library_adapter.h>

Inheritance diagram for FOOTPRINT_LIBRARY_ADAPTER:
LIBRARY_MANAGER_ADAPTER

Public Types

enum  SAVE_T { SAVE_OK , SAVE_SKIPPED }
 The set of return values from SaveSymbol() below. More...
 

Public Member Functions

 FOOTPRINT_LIBRARY_ADAPTER (LIBRARY_MANAGER &aManager)
 
 ~FOOTPRINT_LIBRARY_ADAPTER () override
 
LIBRARY_TABLE_TYPE Type () const override
 The type of library table this adapter works with.
 
std::optional< LIB_STATUS > LoadOne (LIB_DATA *aLib) override
 Loads or reloads the given library, if it exists.
 
std::optional< LIB_STATUS > LoadOne (const wxString &aNickname)
 Loads or reloads the given library, if it exists.
 
std::vector< FOOTPRINT * > GetFootprints (const wxString &aNickname, bool aBestEfforts=false)
 Retrieves a list of footprints contained in a given loaded library.
 
std::vector< wxString > GetFootprintNames (const wxString &aNickname, bool aBestEfforts=false)
 Retrieves a list of footprint names contained in a given loaded library.
 
long long GenerateTimestamp (const wxString *aNickname)
 Generates a filesystem timestamp / hash value for library(ies)
 
void RefreshLibraryIfChanged (const wxString &aNickname)
 Checks whether the library on disk has changed since it was last enumerated into PreloadedFootprints and, if so, clears the stale cache and re-enumerates the library synchronously.
 
void RefreshChangedLibraries ()
 
bool FootprintExists (const wxString &aNickname, const wxString &aName)
 
FOOTPRINT * LoadFootprint (const wxString &aNickname, const wxString &aName, bool aKeepUUID)
 Load a FOOTPRINT having aName from the library given by aNickname.
 
FOOTPRINT * LoadFootprint (const LIB_ID &aLibId, bool aKeepUUID)
 
FOOTPRINT * LoadFootprintWithOptionalNickname (const LIB_ID &aFootprintId, bool aKeepUUID)
 Load a footprint having aFootprintId with possibly an empty nickname.
 
SAVE_T SaveFootprint (const wxString &aNickname, const FOOTPRINT *aFootprint, bool aOverwrite=true)
 Write aFootprint to an existing library given by aNickname.
 
void DeleteFootprint (const wxString &aNickname, const wxString &aFootprintName)
 Deletes the aFootprintName from the library given by aNickname.
 
bool IsFootprintLibWritable (const wxString &aNickname)
 Return true if the library given by aNickname is writable.
 
LIBRARY_MANAGER & Manager () const
 
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 > 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 wxString &aNickname) const
 
virtual int ShowConfigurationDialog (const wxString &aNickname, wxWindow *aParent) const
 
virtual std::optional< LIBRARY_ERROR > LibraryError (const wxString &aNickname) const
 

Static Public Member Functions

static wxString GlobalPathEnvVariableName ()
 

Protected Member Functions

std::map< wxString, LIB_DATA > & globalLibs () override
 
std::map< wxString, LIB_DATA > & globalLibs () const override
 
std::shared_mutex & globalLibsMutex () override
 
std::shared_mutex & globalLibsMutex () const override
 
void enumerateLibrary (LIB_DATA *aLib, const wxString &aUri) override
 Override in derived class to perform library-specific enumeration.
 
LIBRARY_RESULT< IO_BASE * > createPlugin (const LIBRARY_TABLE_ROW *row) override
 Creates a concrete plugin for the given row.
 
IO_BASE * plugin (const LIB_DATA *aRow) override
 
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.
 

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
 

Static Private Member Functions

static PCB_IO * pcbplugin (const LIB_DATA *aRow)
 

Static Private Attributes

static LEAK_AT_EXIT< std::map< wxString, LIB_DATA > > GlobalLibraries
 
static LEAK_AT_EXIT< std::shared_mutex > GlobalLibraryMutex
 
static LEAK_AT_EXIT< std::map< wxString, std::vector< std::unique_ptr< FOOTPRINT > > > > PreloadedFootprints
 Storage for preloaded footprints, indexed by library nickname.
 
static std::shared_mutex PreloadedFootprintsMutex
 
static LEAK_AT_EXIT< std::map< wxString, long long > > PreloadedTimestamps
 Filesystem timestamps from when PreloadedFootprints was last populated, guarded by PreloadedFootprintsMutex.
 

Detailed Description

An interface to the global shared library manager that is schematic-specific and linked to one project in particular.

This is what can return actual concrete schematic library content (symbols).

Definition at line 42 of file footprint_library_adapter.h.

Member Enumeration Documentation

◆ SAVE_T

enum FOOTPRINT_LIBRARY_ADAPTER::SAVE_T

The set of return values from SaveSymbol() below.

Enumerator
SAVE_OK 
SAVE_SKIPPED 

Definition at line 137 of file footprint_library_adapter.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_LIBRARY_ADAPTER()

FOOTPRINT_LIBRARY_ADAPTER::FOOTPRINT_LIBRARY_ADAPTER ( LIBRARY_MANAGER & aManager)

Definition at line 48 of file footprint_library_adapter.cpp.

References LIBRARY_MANAGER_ADAPTER::LIBRARY_MANAGER_ADAPTER().

◆ ~FOOTPRINT_LIBRARY_ADAPTER()

FOOTPRINT_LIBRARY_ADAPTER::~FOOTPRINT_LIBRARY_ADAPTER ( )
override

Definition at line 54 of file footprint_library_adapter.cpp.

References LIBRARY_MANAGER_ADAPTER::evictOwnedGlobalEntries().

Member Function Documentation

◆ AbortAsyncLoad()

void LIBRARY_MANAGER_ADAPTER::AbortAsyncLoad ( )
inherited

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 1153 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 ( )
protectedinherited

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

Definition at line 1429 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 ( )
inherited

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

Definition at line 1853 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(), 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(), and startFootprintLibraryLoad().

◆ AsyncLoadProgress()

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

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 1454 of file library_manager.cpp.

References m_loadCount, and m_loadTotal.

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

◆ BlockUntilLoaded()

void LIBRARY_MANAGER_ADAPTER::BlockUntilLoaded ( )
inherited

Definition at line 1466 of file library_manager.cpp.

References m_futures, m_loadCount, m_loadMutex, m_loadTotal, and traceLibraries.

Referenced by abortLoad(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), filterFootprints(), PCB::IFACE::handleOpenFootprint(), SCH::IFACE::handleOpenSymbol(), PCBNEW_JOBS_HANDLER::JobExportDrc(), EESCHEMA_JOBS_HANDLER::JobSchErc(), LoadNetlistFootprints(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PGM_BASE::PreloadDesignBlockLibraries(), PCB::IFACE::PreloadLibraries(), SCH::IFACE::PreloadLibraries(), and SYMBOL_EDIT_FRAME::SyncLibraries().

◆ CheckLibrary()

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

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

Reimplemented in SYMBOL_LIBRARY_ADAPTER.

Definition at line 162 of file library_manager.h.

References LoadOne().

Referenced by CheckTableRow().

◆ CheckTableRow()

void LIBRARY_MANAGER_ADAPTER::CheckTableRow ( LIBRARY_TABLE_ROW & aRow)
inherited

Definition at line 1256 of file library_manager.cpp.

References abortLoad(), CheckLibrary(), createPlugin(), LIBRARY_TABLE_ROW::Disabled(), fetchIfLoaded(), LIBRARY_TABLE_ROW::IsOk(), LOADED, message, LIBRARY_TABLE_ROW::Nickname(), LIB_DATA::plugin, plugin(), LIB_DATA::row, LIBRARY_TABLE_ROW::SetErrorDescription(), LIBRARY_TABLE_ROW::SetOk(), LIBRARY_TABLE_ROW::Type(), and LIBRARY_TABLE_ROW::URI().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and LIB_TABLE_NOTEBOOK_PANEL::onGridCellChanging().

◆ CreateLibrary()

bool LIBRARY_MANAGER_ADAPTER::CreateLibrary ( const wxString & aNickname)
inherited

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

Definition at line 1662 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()

LIBRARY_RESULT< IO_BASE * > FOOTPRINT_LIBRARY_ADAPTER::createPlugin ( const LIBRARY_TABLE_ROW * row)
overrideprotectedvirtual

Creates a concrete plugin for the given row.

Implements LIBRARY_MANAGER_ADAPTER.

Definition at line 544 of file footprint_library_adapter.cpp.

References _, PCB_IO_MGR::EnumFromStr(), PCB_IO_MGR::FindPlugin(), LIBRARY_MANAGER_ADAPTER::m_manager, PCB_IO_MGR::NESTED_TABLE, LIBRARY_TABLE_ROW::Nickname(), PCB_IO_MGR::PCB_FILE_UNKNOWN, plugin(), LIBRARY_TABLE_ROW::Scope(), traceLibraries, LIBRARY_TABLE_ROW::Type(), and LIBRARY_TABLE_ROW::URI().

◆ DeleteFootprint()

void FOOTPRINT_LIBRARY_ADAPTER::DeleteFootprint ( const wxString & aNickname,
const wxString & aFootprintName )

Deletes the aFootprintName from the library given by aNickname.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aFootprintNameis the name of a footprint to delete from the specified library.
Exceptions
IO_ERRORif there is a problem finding the footprint or the library, or deleting it.

Definition at line 490 of file footprint_library_adapter.cpp.

References LIBRARY_MANAGER_ADAPTER::fetchIfLoaded(), PCB_IO::FootprintDelete(), LIBRARY_MANAGER_ADAPTER::getUri(), pcbplugin(), LIBRARY_MANAGER_ADAPTER::pluginMutex(), PreloadedFootprints, PreloadedFootprintsMutex, traceLibraries, and IO_ERROR::What().

Referenced by FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary().

◆ DeleteLibrary()

bool LIBRARY_MANAGER_ADAPTER::DeleteLibrary ( const wxString & aNickname)
inherited

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

Definition at line 1373 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()

void FOOTPRINT_LIBRARY_ADAPTER::enumerateLibrary ( LIB_DATA * aLib,
const wxString & aUri )
overrideprotectedvirtual

Override in derived class to perform library-specific enumeration.

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

Implements LIBRARY_MANAGER_ADAPTER.

Definition at line 66 of file footprint_library_adapter.cpp.

References FOOTPRINT::Clone(), FOOTPRINT::GetFPID(), LIBRARY_TABLE_ROW::GetOptionsMap(), LIBRARY_TABLE_ROW::Nickname(), pcbplugin(), plugin(), LIBRARY_MANAGER_ADAPTER::pluginMutex(), PreloadedFootprints, PreloadedFootprintsMutex, PreloadedTimestamps, LIB_DATA::row, FOOTPRINT::SetFPID(), LIB_ID::SetLibNickname(), EDA_ITEM::SetParent(), EDA_ITEM::SetParentGroup(), traceLibraries, and IO_ERROR::What().

Referenced by LoadOne(), and RefreshLibraryIfChanged().

◆ evictOwnedGlobalEntries()

void LIBRARY_MANAGER_ADAPTER::evictOwnedGlobalEntries ( )
protectedinherited

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.

Definition at line 1184 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)
protectedinherited

Definition at line 1735 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
protectedinherited

Definition at line 1702 of file library_manager.cpp.

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

Referenced by CheckTableRow(), DESIGN_BLOCK_LIBRARY_ADAPTER::DeleteDesignBlock(), FOOTPRINT_LIBRARY_ADAPTER::DeleteFootprint(), DESIGN_BLOCK_LIBRARY_ADAPTER::DesignBlockExists(), enumerateLibrary(), FOOTPRINT_LIBRARY_ADAPTER::FootprintExists(), FOOTPRINT_LIBRARY_ADAPTER::GenerateTimestamp(), SYMBOL_LIBRARY_ADAPTER::GetAvailableExtraFields(), DESIGN_BLOCK_LIBRARY_ADAPTER::GetDesignBlockNames(), DESIGN_BLOCK_LIBRARY_ADAPTER::GetDesignBlocks(), DESIGN_BLOCK_LIBRARY_ADAPTER::GetEnumeratedDesignBlock(), FOOTPRINT_LIBRARY_ADAPTER::GetFootprintNames(), GetLibraryDescription(), SYMBOL_LIBRARY_ADAPTER::GetLibraryModifyHash(), GetLibraryNames(), SYMBOL_LIBRARY_ADAPTER::GetModifyHash(), SYMBOL_LIBRARY_ADAPTER::GetSubLibraries(), SYMBOL_LIBRARY_ADAPTER::GetSymbolNames(), SYMBOL_LIBRARY_ADAPTER::GetSymbols(), HasLibrary(), DESIGN_BLOCK_LIBRARY_ADAPTER::IsDesignBlockLibWritable(), FOOTPRINT_LIBRARY_ADAPTER::IsFootprintLibWritable(), SYMBOL_LIBRARY_ADAPTER::IsSymbolLibWritable(), IsWritable(), DESIGN_BLOCK_LIBRARY_ADAPTER::LoadDesignBlock(), FOOTPRINT_LIBRARY_ADAPTER::LoadFootprint(), SYMBOL_LIBRARY_ADAPTER::LoadSymbol(), FOOTPRINT_LIBRARY_ADAPTER::RefreshLibraryIfChanged(), DESIGN_BLOCK_LIBRARY_ADAPTER::SaveDesignBlock(), FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint(), SYMBOL_LIBRARY_ADAPTER::ShowConfigurationDialog(), SYMBOL_LIBRARY_ADAPTER::SupportsConfigurationDialog(), and SYMBOL_LIBRARY_ADAPTER::SupportsSubLibraries().

◆ FindLibraryByURI()

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

Definition at line 1327 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
inherited

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

Definition at line 1421 of file library_manager.cpp.

References m_manager, and Type().

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

◆ FootprintExists()

bool FOOTPRINT_LIBRARY_ADAPTER::FootprintExists ( const wxString & aNickname,
const wxString & aName )

Definition at line 308 of file footprint_library_adapter.cpp.

References LIBRARY_MANAGER_ADAPTER::fetchIfLoaded(), PCB_IO::FootprintExists(), LIBRARY_TABLE_ROW::GetOptionsMap(), LIBRARY_MANAGER_ADAPTER::getUri(), pcbplugin(), LIBRARY_MANAGER_ADAPTER::pluginMutex(), and LIB_DATA::row.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::checkFootprintName(), PCB_BASE_FRAME::CreateNewFootprint(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), and CV::testFootprintLink().

◆ GenerateTimestamp()

long long FOOTPRINT_LIBRARY_ADAPTER::GenerateTimestamp ( const wxString * aNickname)

Generates a filesystem timestamp / hash value for library(ies)

Parameters
aNicknameis an optional specific library to timestamp. If nullptr, a timestamp will be calculated for all libraries in the table.
Returns
a value that can be used to determine if libraries have changed on disk

Definition at line 219 of file footprint_library_adapter.cpp.

References LIBRARY_MANAGER_ADAPTER::fetchIfLoaded(), LIBRARY_MANAGER::GetFullURI(), LIBRARY_MANAGER_ADAPTER::GetLibraryNames(), LIBRARY_MANAGER_ADAPTER::HasLibrary(), and plugin().

Referenced by FOOTPRINT_LIST_IMPL::ReadFootprintFiles().

◆ GetFootprintNames()

std::vector< wxString > FOOTPRINT_LIBRARY_ADAPTER::GetFootprintNames ( const wxString & aNickname,
bool aBestEfforts = false )

Retrieves a list of footprint names contained in a given loaded library.

Parameters
aNicknameis the library to query
aBestEffortsif true, don't throw on errors, just return a smaller or empty list.
Returns
a list of names of footprints contained in the given library

Definition at line 186 of file footprint_library_adapter.cpp.

References LIBRARY_MANAGER_ADAPTER::fetchIfLoaded(), PCB_IO::FootprintEnumerate(), LIBRARY_TABLE_ROW::GetOptionsMap(), LIBRARY_MANAGER_ADAPTER::getUri(), name, LIBRARY_TABLE_ROW::Nickname(), pcbplugin(), LIBRARY_MANAGER_ADAPTER::pluginMutex(), LIB_DATA::row, traceLibraries, and IO_ERROR::What().

Referenced by PCB_BASE_FRAME::CreateNewFootprint(), guessNickname(), and DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::loadFootprints().

◆ GetFootprints()

std::vector< FOOTPRINT * > FOOTPRINT_LIBRARY_ADAPTER::GetFootprints ( const wxString & aNickname,
bool aBestEfforts = false )

Retrieves a list of footprints contained in a given loaded library.

Parameters
aNicknameis the library to query
aBestEffortsif true, don't throw on errors, just return a smaller or empty list.
Returns
a list of footprints contained in the given library

Definition at line 166 of file footprint_library_adapter.cpp.

References PreloadedFootprints, and PreloadedFootprintsMutex.

Referenced by filterFootprints(), and FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList().

◆ GetLibraryDescription()

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

Definition at line 1398 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
inherited

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

Definition at line 1551 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
inherited

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

Definition at line 1339 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(), 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
inherited

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

Definition at line 1833 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
inherited

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

Definition at line 1521 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
inherited

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

Definition at line 1414 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(), 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(), RENDER_3D_RAYTRACE_BASE::load3DModels(), RENDER_3D_OPENGL::load3dModels(), 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
protectedinherited

Definition at line 1696 of file library_manager.cpp.

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

Referenced by AsyncLoad(), SYMBOL_LIBRARY_ADAPTER::CheckLibrary(), CreateLibrary(), DESIGN_BLOCK_LIBRARY_ADAPTER::DeleteDesignBlock(), FOOTPRINT_LIBRARY_ADAPTER::DeleteFootprint(), DeleteLibrary(), SYMBOL_LIBRARY_ADAPTER::DeleteSymbol(), DESIGN_BLOCK_LIBRARY_ADAPTER::DesignBlockExists(), enumerateLibrary(), FOOTPRINT_LIBRARY_ADAPTER::FootprintExists(), DESIGN_BLOCK_LIBRARY_ADAPTER::GetDesignBlockNames(), DESIGN_BLOCK_LIBRARY_ADAPTER::GetDesignBlocks(), DESIGN_BLOCK_LIBRARY_ADAPTER::GetEnumeratedDesignBlock(), FOOTPRINT_LIBRARY_ADAPTER::GetFootprintNames(), SYMBOL_LIBRARY_ADAPTER::GetSymbolNames(), SYMBOL_LIBRARY_ADAPTER::GetSymbols(), DESIGN_BLOCK_LIBRARY_ADAPTER::IsDesignBlockLibWritable(), FOOTPRINT_LIBRARY_ADAPTER::IsFootprintLibWritable(), SYMBOL_LIBRARY_ADAPTER::IsSymbolLibWritable(), IsWritable(), DESIGN_BLOCK_LIBRARY_ADAPTER::LoadDesignBlock(), FOOTPRINT_LIBRARY_ADAPTER::LoadFootprint(), DESIGN_BLOCK_LIBRARY_ADAPTER::LoadOne(), FOOTPRINT_LIBRARY_ADAPTER::LoadOne(), SYMBOL_LIBRARY_ADAPTER::LoadOne(), SYMBOL_LIBRARY_ADAPTER::LoadSymbol(), FOOTPRINT_LIBRARY_ADAPTER::RefreshLibraryIfChanged(), DESIGN_BLOCK_LIBRARY_ADAPTER::SaveDesignBlock(), FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint(), and SYMBOL_LIBRARY_ADAPTER::SaveSymbol().

◆ globalLibs() [1/2]

std::map< wxString, LIB_DATA > & FOOTPRINT_LIBRARY_ADAPTER::globalLibs ( ) const
inlineoverrideprotectedvirtual

Implements LIBRARY_MANAGER_ADAPTER.

Definition at line 184 of file footprint_library_adapter.h.

References GlobalLibraries.

◆ globalLibs() [2/2]

std::map< wxString, LIB_DATA > & FOOTPRINT_LIBRARY_ADAPTER::globalLibs ( )
inlineoverrideprotectedvirtual

Implements LIBRARY_MANAGER_ADAPTER.

Definition at line 183 of file footprint_library_adapter.h.

References GlobalLibraries.

◆ globalLibsMutex() [1/2]

std::shared_mutex & FOOTPRINT_LIBRARY_ADAPTER::globalLibsMutex ( ) const
inlineoverrideprotectedvirtual

Implements LIBRARY_MANAGER_ADAPTER.

Definition at line 186 of file footprint_library_adapter.h.

References GlobalLibraryMutex.

◆ globalLibsMutex() [2/2]

std::shared_mutex & FOOTPRINT_LIBRARY_ADAPTER::globalLibsMutex ( )
inlineoverrideprotectedvirtual

Implements LIBRARY_MANAGER_ADAPTER.

Definition at line 185 of file footprint_library_adapter.h.

References GlobalLibraryMutex.

◆ GlobalPathEnvVariableName()

wxString FOOTPRINT_LIBRARY_ADAPTER::GlobalPathEnvVariableName ( )
static

Definition at line 60 of file footprint_library_adapter.cpp.

References ENV_VAR::GetVersionedEnvVarName().

Referenced by DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES().

◆ GlobalTable()

LIBRARY_TABLE * LIBRARY_MANAGER_ADAPTER::GlobalTable ( ) const
inherited

Retrieves the global library table for this adapter type.

Definition at line 1314 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 = {})
inherited

Notify the adapter that the global library tables have changed.

Definition at line 1159 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
inherited

Test for the existence of aNickname in the library tables.

Parameters
aNicknameis the library nickname.
aCheckEnabledif true will only return true for enabled libraries
Returns
true if a library aNickname exists in the loaded tables.

Definition at line 1362 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_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().

◆ IsFootprintLibWritable()

bool FOOTPRINT_LIBRARY_ADAPTER::IsFootprintLibWritable ( const wxString & aNickname)

Return true if the library given by aNickname is writable.

It is possible that some footprint libraries are read only because of where they are installed.

Parameters
aNicknameis the library nickname in the footprint library table.
Exceptions
IO_ERRORif no library at aNickname exists.

Definition at line 529 of file footprint_library_adapter.cpp.

References LIBRARY_MANAGER_ADAPTER::fetchIfLoaded(), LIBRARY_MANAGER_ADAPTER::getUri(), and LIBRARY_MANAGER_ADAPTER::pluginMutex().

Referenced by FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), and DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::DIALOG_LIB_FOOTPRINT_FIELDS_TABLE().

◆ IsLibraryLoaded()

bool LIBRARY_MANAGER_ADAPTER::IsLibraryLoaded ( const wxString & aNickname)
inherited

Definition at line 1481 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
virtualinherited

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

Definition at line 1645 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
virtualinherited

Definition at line 1501 of file library_manager.cpp.

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

Referenced by LIB_TABLE_GRID_TRICKS::onGridCellLeftClick().

◆ LoadFootprint() [1/2]

FOOTPRINT * FOOTPRINT_LIBRARY_ADAPTER::LoadFootprint ( const LIB_ID & aLibId,
bool aKeepUUID )
inline

Definition at line 112 of file footprint_library_adapter.h.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), and LoadFootprint().

◆ LoadFootprint() [2/2]

FOOTPRINT * FOOTPRINT_LIBRARY_ADAPTER::LoadFootprint ( const wxString & aNickname,
const wxString & aName,
bool aKeepUUID )

Load a FOOTPRINT having aName from the library given by aNickname.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIBRARY_TABLE_ROW
aNameis the name of the FOOTPRINT to load.
aKeepUUID= true to keep initial items UUID, false to set new UUID normally true if loaded in the footprint editor, false if loaded in the board editor. Make sense only in kicad_plugin
Returns
the footprint if found or NULL if not found.
Exceptions
IO_ERRORif the library cannot be found or read. No exception is thrown in the case where aNickname cannot be found.

Definition at line 324 of file footprint_library_adapter.cpp.

References copy, LIBRARY_MANAGER_ADAPTER::fetchIfLoaded(), PCB_IO::FootprintLoad(), LIBRARY_MANAGER_ADAPTER::getUri(), IGNORE_PARENT_GROUP, pcbplugin(), LIBRARY_MANAGER_ADAPTER::pluginMutex(), PreloadedFootprints, PreloadedFootprintsMutex, LIB_ID::SetLibNickname(), traceLibraries, and IO_ERROR::What().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_BASE_FRAME::CreateNewFootprint(), BOARD_INSPECTION_TOOL::DiffFootprint(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CV::getFootprintPadNumbers(), FOOTPRINT_INFO_IMPL::load(), LoadFootprint(), DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::loadFootprints(), LoadFootprintWithOptionalNickname(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), API_HANDLER_FP_LIBRARIES::packLibraryItem(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), and DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow().

◆ LoadFootprintWithOptionalNickname()

FOOTPRINT * FOOTPRINT_LIBRARY_ADAPTER::LoadFootprintWithOptionalNickname ( const LIB_ID & aFootprintId,
bool aKeepUUID )

Load a footprint having aFootprintId with possibly an empty nickname.

Parameters
aFootprintIdthe [nickname] and name of the design block to load.
aKeepUUID= true to keep initial items UUID, false to set new UUID normally true if loaded in the footprint editor, false if loaded in the board editor used only in kicad_plugin
Returns
the FOOTPRINT if found caller owns it, else NULL if not found.
Exceptions
IO_ERRORif the library cannot be found or read. No exception is thrown in the case where aFootprintId cannot be found.
PARSE_ERRORif aFootprintId is not parsed OK.

Definition at line 384 of file footprint_library_adapter.cpp.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIBRARY_MANAGER_ADAPTER::GetLibraryNames(), library, and LoadFootprint().

Referenced by PCB::IFACE::handleOpenFootprint(), API_HANDLER_FOOTPRINT::handleOpenLibraryItem(), and LoadFootprintFromProject().

◆ 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 )
protectedinherited

Definition at line 1768 of file library_manager.cpp.

References createPlugin(), GLOBAL, LOADING, m_manager, LIBRARY_TABLE_ROW::Nickname(), plugin(), result, traceLibraries, and Type().

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

◆ loadIfNeeded()

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

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

Definition at line 1815 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)
inherited

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 1575 of file library_manager.cpp.

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

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

◆ LoadOne() [1/2]

std::optional< LIB_STATUS > FOOTPRINT_LIBRARY_ADAPTER::LoadOne ( const wxString & aNickname)

Loads or reloads the given library, if it exists.

Definition at line 152 of file footprint_library_adapter.cpp.

References LOAD_ERROR, LIBRARY_MANAGER_ADAPTER::loadIfNeeded(), LoadOne(), and result.

◆ LoadOne() [2/2]

std::optional< LIB_STATUS > FOOTPRINT_LIBRARY_ADAPTER::LoadOne ( LIB_DATA * aLib)
overridevirtual

Loads or reloads the given library, if it exists.

Implements LIBRARY_MANAGER_ADAPTER.

Definition at line 132 of file footprint_library_adapter.cpp.

References enumerateLibrary(), LIB_STATUS::error, LIBRARY_MANAGER_ADAPTER::getUri(), LOAD_ERROR, LIB_STATUS::load_status, LOADED, LOADING, LIBRARY_TABLE_ROW::Nickname(), IO_ERROR::Problem(), LIB_DATA::row, LIB_DATA::status, traceLibraries, IO_ERROR::What(), and IO_ERROR::Where().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), CV::getFootprintPadNumbers(), PCB_EDIT_FRAME::KiwayMailIn(), LoadOne(), and CV::testFootprintLink().

◆ Manager()

LIBRARY_MANAGER & LIBRARY_MANAGER_ADAPTER::Manager ( ) const
inherited

Definition at line 1124 of file library_manager.cpp.

References m_manager.

◆ pcbplugin()

PCB_IO * FOOTPRINT_LIBRARY_ADAPTER::pcbplugin ( const LIB_DATA * aRow)
staticprivate

Definition at line 577 of file footprint_library_adapter.cpp.

References IO_BASE::IsPCB_IO(), and LIB_DATA::plugin.

Referenced by DeleteFootprint(), enumerateLibrary(), FootprintExists(), GetFootprintNames(), LoadFootprint(), plugin(), and SaveFootprint().

◆ plugin()

IO_BASE * FOOTPRINT_LIBRARY_ADAPTER::plugin ( const LIB_DATA * aRow)
inlineoverrideprotectedvirtual

Implements LIBRARY_MANAGER_ADAPTER.

Definition at line 192 of file footprint_library_adapter.h.

References pcbplugin().

Referenced by createPlugin(), enumerateLibrary(), GenerateTimestamp(), and RefreshLibraryIfChanged().

◆ pluginMutex()

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

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 ( )
virtualinherited

Notify the adapter that the active project has changed.

Definition at line 1130 of file library_manager.cpp.

References resetProjectCache().

◆ ProjectTable()

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

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

Definition at line 1321 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(), 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 = {})
inherited

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 1202 of file library_manager.cpp.

References resetProjectCache(), and Type().

◆ ProjectTablesReloaded()

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

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 1222 of file library_manager.cpp.

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

◆ RefreshChangedLibraries()

void FOOTPRINT_LIBRARY_ADAPTER::RefreshChangedLibraries ( )

Definition at line 291 of file footprint_library_adapter.cpp.

References LIBRARY_MANAGER_ADAPTER::GetLibraryNames(), RefreshLibraryIfChanged(), traceLibraries, and IO_ERROR::What().

Referenced by PCB_EDIT_FRAME::HardRedraw(), and PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER().

◆ RefreshLibraryIfChanged()

void FOOTPRINT_LIBRARY_ADAPTER::RefreshLibraryIfChanged ( const wxString & aNickname)

Checks whether the library on disk has changed since it was last enumerated into PreloadedFootprints and, if so, clears the stale cache and re-enumerates the library synchronously.

This allows external changes such as git branch switches to be picked up without restarting KiCad.

Parameters
aNicknameis the library to check and potentially refresh.

Definition at line 251 of file footprint_library_adapter.cpp.

References enumerateLibrary(), LIBRARY_MANAGER_ADAPTER::fetchIfLoaded(), LIBRARY_MANAGER_ADAPTER::getUri(), plugin(), LIB_DATA::plugin, PreloadedFootprints, PreloadedFootprintsMutex, PreloadedTimestamps, LIB_DATA::row, and traceLibraries.

Referenced by FOOTPRINT_VIEWER_FRAME::ClickOnLibList(), and RefreshChangedLibraries().

◆ ReloadLibraryEntry()

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

Synchronously recreates the plugin for and reloads the given library.

Definition at line 1586 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().

◆ resetProjectCache()

void LIBRARY_MANAGER_ADAPTER::resetProjectCache ( )
protectedinherited

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 1136 of file library_manager.cpp.

References abortLoad(), m_libraries, and m_librariesMutex.

Referenced by enumerateLibrary(), ProjectChanged(), and ProjectTablesChanged().

◆ Rows()

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

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

Definition at line 1407 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().

◆ SaveFootprint()

FOOTPRINT_LIBRARY_ADAPTER::SAVE_T FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint ( const wxString & aNickname,
const FOOTPRINT * aFootprint,
bool aOverwrite = true )

Write aFootprint to an existing library given by aNickname.

If a FOOTPRINT by the same name already exists or there are any conflicting alias names, the new FOOTPRINT will silently overwrite any existing aliases and/or part because libraries cannot have duplicate alias names. It is the responsibility of the caller to check the library for conflicts before saving.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW
aFootprintis what to store in the library. The library owns the footprint after this call.
aOverwritewhen true means overwrite any existing symbol by the same name, else if false means skip the write and return SAVE_SKIPPED.
Returns
SAVE_T - SAVE_OK or SAVE_SKIPPED. If error saving, then IO_ERROR is thrown.
Exceptions
IO_ERRORif there is a problem saving the footprint.

Definition at line 405 of file footprint_library_adapter.cpp.

References FOOTPRINT::Clone(), LIBRARY_MANAGER_ADAPTER::fetchIfLoaded(), PCB_IO::FootprintLoad(), PCB_IO::FootprintSave(), FOOTPRINT::GetFPID(), FOOTPRINT::GetFPIDAsString(), LIB_ID::GetLibItemName(), LIBRARY_MANAGER_ADAPTER::getUri(), pcbplugin(), LIBRARY_MANAGER_ADAPTER::pluginMutex(), PreloadedFootprints, PreloadedFootprintsMutex, SAVE_OK, SAVE_SKIPPED, FOOTPRINT::SetFPID(), LIB_ID::SetLibNickname(), EDA_ITEM::SetParent(), EDA_ITEM::SetParentGroup(), traceLibraries, and IO_ERROR::What().

Referenced by FOOTPRINT_EDITOR_CONTROL::editFootprintPropertiesFromLibrary(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), and HEADLESS_FOOTPRINT_CONTEXT::SaveFootprintInLibrary().

◆ ShowConfigurationDialog()

virtual int LIBRARY_MANAGER_ADAPTER::ShowConfigurationDialog ( const wxString & aNickname,
wxWindow * aParent ) const
inlinevirtualinherited

Reimplemented in SYMBOL_LIBRARY_ADAPTER.

Definition at line 207 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 wxString & aNickname) const
inlinevirtualinherited

Reimplemented in SYMBOL_LIBRARY_ADAPTER.

Definition at line 205 of file library_manager.h.

Referenced by LIB_TABLE_GRID_TRICKS::onGridCellLeftClick().

◆ Type()

LIBRARY_TABLE_TYPE FOOTPRINT_LIBRARY_ADAPTER::Type ( ) const
inlineoverridevirtual

The type of library table this adapter works with.

Implements LIBRARY_MANAGER_ADAPTER.

Definition at line 49 of file footprint_library_adapter.h.

References FOOTPRINT.

Member Data Documentation

◆ GlobalLibraries

LEAK_AT_EXIT< std::map< wxString, LIB_DATA > > FOOTPRINT_LIBRARY_ADAPTER::GlobalLibraries
staticprivate

Definition at line 197 of file footprint_library_adapter.h.

Referenced by globalLibs(), and globalLibs().

◆ GlobalLibraryMutex

LEAK_AT_EXIT< std::shared_mutex > FOOTPRINT_LIBRARY_ADAPTER::GlobalLibraryMutex
staticprivate

Definition at line 200 of file footprint_library_adapter.h.

Referenced by globalLibsMutex(), and globalLibsMutex().

◆ m_abort

std::atomic_bool LIBRARY_MANAGER_ADAPTER::m_abort
protectedinherited

Definition at line 279 of file library_manager.h.

Referenced by abortLoad().

◆ m_futures

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

Definition at line 280 of file library_manager.h.

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

◆ m_libraries

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

Definition at line 275 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
mutableprotectedinherited

Definition at line 277 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 }
protectedinherited

Definition at line 282 of file library_manager.h.

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

◆ m_loadMutex

std::mutex LIBRARY_MANAGER_ADAPTER::m_loadMutex
protectedinherited

Definition at line 284 of file library_manager.h.

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

◆ m_loadTotal

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

Definition at line 283 of file library_manager.h.

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

◆ m_manager

LIBRARY_MANAGER& LIBRARY_MANAGER_ADAPTER::m_manager
protectedinherited

Definition at line 272 of file library_manager.h.

Referenced by AsyncLoad(), DESIGN_BLOCK_LIBRARY_ADAPTER::createPlugin(), FOOTPRINT_LIBRARY_ADAPTER::createPlugin(), SYMBOL_LIBRARY_ADAPTER::createPlugin(), fetchIfLoaded(), fetchIfLoaded(), FindLibraryByURI(), FindRowByURI(), GetLibraryNames(), GetLibraryStatuses(), SYMBOL_LIBRARY_ADAPTER::GetModifyHash(), GetRow(), getUri(), SYMBOL_LIBRARY_ADAPTER::globalLibs(), SYMBOL_LIBRARY_ADAPTER::globalLibs(), SYMBOL_LIBRARY_ADAPTER::globalLibsMutex(), SYMBOL_LIBRARY_ADAPTER::globalLibsMutex(), GlobalTable(), LIBRARY_MANAGER_ADAPTER(), loadFromScope(), Manager(), ProjectTable(), ProjectTablesReloaded(), and Rows().

◆ PreloadedFootprints

LEAK_AT_EXIT< std::map< wxString, std::vector< std::unique_ptr< FOOTPRINT > > > > FOOTPRINT_LIBRARY_ADAPTER::PreloadedFootprints
staticprivate

Storage for preloaded footprints, indexed by library nickname.

These are cloned during library enumeration so GetFootprints() returns instantly.

Definition at line 204 of file footprint_library_adapter.h.

Referenced by DeleteFootprint(), enumerateLibrary(), GetFootprints(), LoadFootprint(), RefreshLibraryIfChanged(), and SaveFootprint().

◆ PreloadedFootprintsMutex

std::shared_mutex FOOTPRINT_LIBRARY_ADAPTER::PreloadedFootprintsMutex
staticprivate

Definition at line 205 of file footprint_library_adapter.h.

Referenced by DeleteFootprint(), enumerateLibrary(), GetFootprints(), LoadFootprint(), RefreshLibraryIfChanged(), and SaveFootprint().

◆ PreloadedTimestamps

LEAK_AT_EXIT< std::map< wxString, long long > > FOOTPRINT_LIBRARY_ADAPTER::PreloadedTimestamps
staticprivate

Filesystem timestamps from when PreloadedFootprints was last populated, guarded by PreloadedFootprintsMutex.

Static so it shares the lifetime of the cache it describes.

Definition at line 209 of file footprint_library_adapter.h.

Referenced by enumerateLibrary(), and RefreshLibraryIfChanged().

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