#include <footprint_info_impl.h>

Inheritance diagram for FOOTPRINT_LIST_IMPL:

Public Member Functions
	FOOTPRINT_LIST_IMPL ()

virtual	~FOOTPRINT_LIST_IMPL ()

void	WriteCacheToFile (const wxString &aFilePath) override

void	ReadCacheFromFile (const wxString &aFilePath) override

bool	ReadFootprintFiles (FP_LIB_TABLE aTable, const wxString aNickname=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr) override
	Read all the footprints provided by the combination of aTable and aNickname.

void	Clear () override

unsigned	GetCount () const

const std::vector< std::unique_ptr< FOOTPRINT_INFO > > &	GetList () const
	Was forced to add this by modview_frame.cpp.

FOOTPRINT_INFO *	GetFootprintInfo (const wxString &aFootprintName)
	Get info for a footprint by id.

FOOTPRINT_INFO *	GetFootprintInfo (const wxString &aLibNickname, const wxString &aFootprintName)
	Get info for a footprint by libNickname/footprintName.

FOOTPRINT_INFO &	GetItem (unsigned aIdx) const
	Get info for a footprint by index.

unsigned	GetErrorCount () const

std::unique_ptr< IO_ERROR >	PopError ()

void	DisplayErrors (wxTopLevelWindow *aCaller=nullptr)

FP_LIB_TABLE *	GetTable () const

Static Public Member Functions
static FOOTPRINT_LIST *	GetInstance (KIWAY &aKiway)
	Factory function to return a FOOTPRINT_LIST via Kiway.

Protected Member Functions
void	loadLibs ()

void	loadFootprints ()

Protected Attributes
FP_LIB_TABLE *	m_lib_table
	no ownership

std::vector< std::unique_ptr< FOOTPRINT_INFO > >	m_list

SYNC_QUEUE< std::unique_ptr< IO_ERROR > >	m_errors
	some can be PARSE_ERRORs also

Private Member Functions
bool	CatchErrors (const std::function< void()> &aFunc)
	Call aFunc, pushing any IO_ERRORs and std::exceptions it throws onto m_errors.

Private Attributes
SYNC_QUEUE< wxString >	m_queue_in

SYNC_QUEUE< wxString >	m_queue_out

long long	m_list_timestamp

PROGRESS_REPORTER *	m_progress_reporter

std::atomic_bool	m_cancelled

std::mutex	m_join

Detailed Description

Definition at line 84 of file footprint_info_impl.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_LIST_IMPL()

FOOTPRINT_LIST_IMPL::FOOTPRINT_LIST_IMPL ( )

Definition at line 307 of file footprint_info_impl.cpp.

◆ ~FOOTPRINT_LIST_IMPL()

virtual FOOTPRINT_LIST_IMPL::~FOOTPRINT_LIST_IMPL ( )

inlinevirtual

Definition at line 88 of file footprint_info_impl.h.

Member Function Documentation

◆ CatchErrors()

bool FOOTPRINT_LIST_IMPL::CatchErrors ( const std::function< void()> & aFunc )

private

Call aFunc, pushing any IO_ERRORs and std::exceptions it throws onto m_errors.

Returns: true if no error occurred.

Definition at line 76 of file footprint_info_impl.cpp.

References FOOTPRINT_LIST::m_errors, SYNC_QUEUE< T >::move_push(), and THROW_IO_ERROR.

Referenced by loadFootprints(), loadLibs(), and ReadFootprintFiles().

◆ Clear()

void FOOTPRINT_LIST_IMPL::Clear ( )

overridevirtual

Returns: Clears the footprint info cache

Implements FOOTPRINT_LIST.

Definition at line 69 of file footprint_info_impl.cpp.

References FOOTPRINT_LIST::m_list, and m_list_timestamp.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ DisplayErrors()

void FOOTPRINT_LIST::DisplayErrors ( wxTopLevelWindow * aCaller = nullptr )

inherited

Definition at line 113 of file footprint_info.cpp.

References _, HTML_MESSAGE_BOX::AddHTML_Text(), EscapeHTML(), HTML_MESSAGE_BOX::MessageSet(), FOOTPRINT_LIST::PopError(), and DIALOG_SHIM::ShowModal().

Referenced by FOOTPRINT_EDIT_FRAME::initLibraryTree(), CVPCB_MAINFRAME::LoadFootprintFiles(), and PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER().

◆ GetCount()

unsigned FOOTPRINT_LIST::GetCount ( ) const

inlineinherited

Returns: the number of items stored in list

Definition at line 178 of file footprint_info.h.

Referenced by FOOTPRINT_FILTER::ITERATOR::dereference(), FOOTPRINT_FILTER::end(), FOOTPRINT_LIST::GetInstance(), FOOTPRINT_FILTER::ITERATOR::increment(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), FOOTPRINT_SELECT_WIDGET::Load(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetErrorCount()

unsigned FOOTPRINT_LIST::GetErrorCount ( ) const

inlineinherited

Definition at line 216 of file footprint_info.h.

Referenced by FOOTPRINT_EDIT_FRAME::initLibraryTree(), CVPCB_MAINFRAME::LoadFootprintFiles(), and PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER().

◆ GetFootprintInfo() [1/2]

FOOTPRINT_INFO * FOOTPRINT_LIST::GetFootprintInfo ( const wxString & aFootprintName )

inherited

Get info for a footprint by id.

Definition at line 59 of file footprint_info.cpp.

References FOOTPRINT_LIST::GetFootprintInfo(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), and LIB_ID::Parse().

Referenced by CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::AutomaticFootprintMatching(), CVPCB_MAINFRAME::DisplayStatus(), FOOTPRINT_LIST::GetFootprintInfo(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), and CVPCB_MAINFRAME::readNetListAndFpFiles().

◆ GetFootprintInfo() [2/2]

FOOTPRINT_INFO * FOOTPRINT_LIST::GetFootprintInfo	(	const wxString &	aLibNickname,
		const wxString &	aFootprintName
	)

inherited

Get info for a footprint by libNickname/footprintName.

Definition at line 43 of file footprint_info.cpp.

References FOOTPRINT_LIST::m_list.

◆ GetInstance()

FOOTPRINT_LIST * FOOTPRINT_LIST::GetInstance ( KIWAY & aKiway )

staticinherited

Factory function to return a FOOTPRINT_LIST via Kiway.

This is not guaranteed to succeed and will return null if the kiface is not available.

Parameters

aKiway active kiway instance.

Definition at line 163 of file footprint_info.cpp.

References get_instance_from_id(), FOOTPRINT_LIST::GetCount(), PROJECT::GetProjectPath(), KIFACE_FOOTPRINT_LIST, KIWAY::Prj(), and FOOTPRINT_LIST::ReadCacheFromFile().

Referenced by PANEL_SYMBOL_CHOOSER::constructRightPanel(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_SELECT_WIDGET::Load(), and FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList().

◆ GetItem()

FOOTPRINT_INFO & FOOTPRINT_LIST::GetItem ( unsigned aIdx ) const

inlineinherited

Get info for a footprint by index.

Parameters

aIdx	index of the given item.

Returns: the aIdx item in list.

Definition at line 211 of file footprint_info.h.

Referenced by FOOTPRINT_FILTER::ITERATOR::increment().

◆ GetList()

const std::vector< std::unique_ptr< FOOTPRINT_INFO > > & FOOTPRINT_LIST::GetList ( ) const

inlineinherited

Was forced to add this by modview_frame.cpp.

Definition at line 184 of file footprint_info.h.

Referenced by FP_TREE_MODEL_ADAPTER::getFootprints().

◆ GetTable()

FP_LIB_TABLE * FOOTPRINT_LIST::GetTable ( ) const

inlineinherited

Definition at line 246 of file footprint_info.h.

Referenced by FOOTPRINT_INFO_IMPL::load().

◆ loadFootprints()

void FOOTPRINT_LIST_IMPL::loadFootprints ( )

protected

Definition at line 226 of file footprint_info_impl.cpp.

References PROGRESS_REPORTER::AdvanceProgress(), CatchErrors(), FP_LIB_TABLE::FootprintEnumerate(), GetKiCadThreadPool(), PROGRESS_REPORTER::KeepRefreshing(), m_cancelled, FOOTPRINT_LIST::m_lib_table, FOOTPRINT_LIST::m_list, m_progress_reporter, m_queue_out, SYNC_QUEUE< T >::move_push(), SYNC_QUEUE< T >::pop(), SYNC_QUEUE< T >::size(), and tp.

Referenced by ReadFootprintFiles().

◆ loadLibs()

void FOOTPRINT_LIST_IMPL::loadLibs ( )

protected

Definition at line 179 of file footprint_info_impl.cpp.

References PROGRESS_REPORTER::AdvanceProgress(), CatchErrors(), GetKiCadThreadPool(), PROGRESS_REPORTER::KeepRefreshing(), m_cancelled, FOOTPRINT_LIST::m_lib_table, m_progress_reporter, m_queue_in, m_queue_out, SYNC_QUEUE< T >::pop(), FP_LIB_TABLE::PrefetchLib(), SYNC_QUEUE< T >::push(), SYNC_QUEUE< T >::size(), and tp.

Referenced by ReadFootprintFiles().

◆ PopError()

std::unique_ptr< IO_ERROR > FOOTPRINT_LIST::PopError ( )

inlineinherited

Definition at line 221 of file footprint_info.h.

Referenced by FOOTPRINT_LIST::DisplayErrors().

◆ ReadCacheFromFile()

void FOOTPRINT_LIST_IMPL::ReadCacheFromFile ( const wxString & aFilePath )

overridevirtual

Reimplemented from FOOTPRINT_LIST.

Definition at line 354 of file footprint_info_impl.cpp.

References FOOTPRINT_LIST::m_list, m_list_timestamp, name, and UnescapeString().

Referenced by FOOTPRINT_EDIT_FRAME::initLibraryTree(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ ReadFootprintFiles()

bool FOOTPRINT_LIST_IMPL::ReadFootprintFiles	(	FP_LIB_TABLE *	aTable,
		const wxString *	aNickname = `nullptr`,
		PROGRESS_REPORTER *	aProgressReporter = `nullptr`
	)

overridevirtual

Read all the footprints provided by the combination of aTable and aNickname.

Parameters

aTable	defines all the libraries.
aNickname	is the library to read from, or if NULL means read all footprints from all known libraries in aTable.
aProgressReporter	is an optional progress reporter. ReadFootprintFiles() will use 2 phases within the reporter.

Returns: true if it ran to completion, else false if it aborted after some number of errors. If true, it does not mean there were no errors, check GetErrorCount() for that, should be zero to indicate success.

Implements FOOTPRINT_LIST.

Definition at line 107 of file footprint_info_impl.cpp.

References _, PROGRESS_REPORTER::AdvancePhase(), CatchErrors(), SYNC_QUEUE< T >::clear(), SYNC_QUEUE< T >::empty(), FP_LIB_TABLE::GenerateTimestamp(), LIB_TABLE::GetLogicalLibs(), loadFootprints(), loadLibs(), m_cancelled, FOOTPRINT_LIST::m_errors, FOOTPRINT_LIST::m_lib_table, FOOTPRINT_LIST::m_list, m_list_timestamp, m_progress_reporter, m_queue_in, m_queue_out, SYNC_QUEUE< T >::push(), PROGRESS_REPORTER::Report(), PROGRESS_REPORTER::SetMaxProgress(), and SYNC_QUEUE< T >::size().

Referenced by FOOTPRINT_EDIT_FRAME::initLibraryTree(), FOOTPRINT_SELECT_WIDGET::Load(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), and FOOTPRINT_EDIT_FRAME::SyncLibraryTree().

◆ WriteCacheToFile()

void FOOTPRINT_LIST_IMPL::WriteCacheToFile ( const wxString & aFilePath )

overridevirtual

Reimplemented from FOOTPRINT_LIST.

Definition at line 315 of file footprint_info_impl.cpp.

References CTX_LINE, KIPLATFORM::IO::DuplicatePermissions(), EscapeString(), FOOTPRINT_LIST::m_list, and m_list_timestamp.

Referenced by FOOTPRINT_EDIT_FRAME::doCloseWindow(), and PCB_BASE_EDIT_FRAME::doCloseWindow().

Member Data Documentation

◆ m_cancelled

std::atomic_bool FOOTPRINT_LIST_IMPL::m_cancelled

private

Definition at line 114 of file footprint_info_impl.h.

Referenced by loadFootprints(), loadLibs(), and ReadFootprintFiles().

◆ m_errors

SYNC_QUEUE<std::unique_ptr<IO_ERROR> > FOOTPRINT_LIST::m_errors

protectedinherited

some can be PARSE_ERRORs also

Definition at line 264 of file footprint_info.h.

Referenced by CatchErrors(), and ReadFootprintFiles().

◆ m_join

std::mutex FOOTPRINT_LIST_IMPL::m_join

private

Definition at line 115 of file footprint_info_impl.h.

◆ m_lib_table

FP_LIB_TABLE* FOOTPRINT_LIST::m_lib_table

protectedinherited

no ownership

Definition at line 261 of file footprint_info.h.

Referenced by loadFootprints(), loadLibs(), and ReadFootprintFiles().

◆ m_list

std::vector<std::unique_ptr<FOOTPRINT_INFO> > FOOTPRINT_LIST::m_list

protectedinherited

Definition at line 263 of file footprint_info.h.

Referenced by Clear(), FOOTPRINT_LIST::GetFootprintInfo(), FOOTPRINT_FILTER::ITERATOR::increment(), loadFootprints(), ReadCacheFromFile(), ReadFootprintFiles(), and WriteCacheToFile().

◆ m_list_timestamp

long long FOOTPRINT_LIST_IMPL::m_list_timestamp

private

Definition at line 112 of file footprint_info_impl.h.

Referenced by Clear(), ReadCacheFromFile(), ReadFootprintFiles(), and WriteCacheToFile().

◆ m_progress_reporter

PROGRESS_REPORTER* FOOTPRINT_LIST_IMPL::m_progress_reporter

private

Definition at line 113 of file footprint_info_impl.h.

Referenced by loadFootprints(), loadLibs(), and ReadFootprintFiles().

◆ m_queue_in

SYNC_QUEUE<wxString> FOOTPRINT_LIST_IMPL::m_queue_in

private

Definition at line 110 of file footprint_info_impl.h.

Referenced by loadLibs(), and ReadFootprintFiles().

◆ m_queue_out

SYNC_QUEUE<wxString> FOOTPRINT_LIST_IMPL::m_queue_out

private

Definition at line 111 of file footprint_info_impl.h.

Referenced by loadFootprints(), loadLibs(), and ReadFootprintFiles().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FOOTPRINT_LIST_IMPL()

◆ ~FOOTPRINT_LIST_IMPL()

Member Function Documentation

◆ CatchErrors()

◆ Clear()

◆ DisplayErrors()

◆ GetCount()

◆ GetErrorCount()

◆ GetFootprintInfo() [1/2]

◆ GetFootprintInfo() [2/2]

◆ GetInstance()

◆ GetItem()

◆ GetList()

◆ GetTable()

◆ loadFootprints()

◆ loadLibs()

◆ PopError()

◆ ReadCacheFromFile()

◆ ReadFootprintFiles()

◆ WriteCacheToFile()

Member Data Documentation

◆ m_cancelled

◆ m_errors

◆ m_join

◆ m_lib_table

◆ m_list

◆ m_list_timestamp

◆ m_progress_reporter

◆ m_queue_in

◆ m_queue_out