Holds a list of FOOTPRINT_INFO objects, along with a list of IO_ERRORs or PARSE_ERRORs that were thrown acquiring the FOOTPRINT_INFOs. More...

#include <footprint_info.h>

Inheritance diagram for FOOTPRINT_LIST:

Public Types
typedef std::vector< std::unique_ptr< FOOTPRINT_INFO > >	FPILIST

typedef SYNC_QUEUE< std::unique_ptr< IO_ERROR > >	ERRLIST

Public Member Functions
	FOOTPRINT_LIST ()

virtual	~FOOTPRINT_LIST ()

virtual void	WriteCacheToFile (const wxString &aFilePath)

virtual void	ReadCacheFromFile (const wxString &aFilePath)

unsigned	GetCount () const

const FPILIST &	GetList () const
	Was forced to add this by modview_frame.cpp. More...

void	Clear ()

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

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

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

unsigned	GetErrorCount () const

std::unique_ptr< IO_ERROR >	PopError ()

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

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. More...

Protected Member Functions
virtual void	startWorkers (FP_LIB_TABLE aTable, const wxString aNickname, FOOTPRINT_ASYNC_LOADER *aLoader, unsigned aNThreads)=0
	Launch worker threads to load footprints. More...

virtual bool	joinWorkers ()=0
	Join worker threads. More...

virtual void	stopWorkers ()=0
	Stop worker threads. More...

Protected Attributes
FP_LIB_TABLE *	m_lib_table
	no ownership More...

FPILIST	m_list

ERRLIST	m_errors
	some can be PARSE_ERRORs also More...

Friends
class	FOOTPRINT_ASYNC_LOADER

Detailed Description

Holds a list of FOOTPRINT_INFO objects, along with a list of IO_ERRORs or PARSE_ERRORs that were thrown acquiring the FOOTPRINT_INFOs.

This is a virtual class; its implementation lives in pcbnew/footprint_info_impl.cpp. To get instances of these classes, see FOOTPRINT_LIST::GetInstance().

Definition at line 166 of file footprint_info.h.

Member Typedef Documentation

◆ ERRLIST

typedef SYNC_QUEUE<std::unique_ptr<IO_ERROR> > FOOTPRINT_LIST::ERRLIST

Definition at line 170 of file footprint_info.h.

◆ FPILIST

typedef std::vector<std::unique_ptr<FOOTPRINT_INFO> > FOOTPRINT_LIST::FPILIST

Definition at line 169 of file footprint_info.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_LIST()

FOOTPRINT_LIST::FOOTPRINT_LIST ( )

inline

Definition at line 172 of file footprint_info.h.

  : m_lib_table( nullptr )
  {
  }

◆ ~FOOTPRINT_LIST()

virtual FOOTPRINT_LIST::~FOOTPRINT_LIST ( )

inlinevirtual

Definition at line 176 of file footprint_info.h.

177 {

178 }

Member Function Documentation

◆ Clear()

void FOOTPRINT_LIST::Clear ( )

inline

Returns: Clears the footprint info cache

Definition at line 200 of file footprint_info.h.

  {
  m_list.clear();
  }

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ DisplayErrors()

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

Definition at line 93 of file footprint_info.cpp.

 {
  // @todo: go to a more HTML !<table>! ? centric output, possibly with recommendations
  // for remedy of errors. Add numeric error codes to PARSE_ERROR, and switch on them for
  // remedies, etc. Full access is provided to everything in every exception!
 
  HTML_MESSAGE_BOX dlg( aWindow, _( "Load Error" ) );
 
  dlg.MessageSet( _( "Errors were encountered loading footprints:" ) );
 
  wxString msg;
 
  while( std::unique_ptr<IO_ERROR> error = PopError() )
  {
  wxString tmp = error->Problem();
 
  // Preserve new lines in error messages so queued errors don't run together.
  tmp.Replace( wxT( "\n" ), wxT( "<BR>" ) );
  msg += wxT( "<p>" ) + tmp + wxT( "</p>" );
  }
 
  dlg.AddHTML_Text( msg );
 
  dlg.ShowModal();
 }

References _, HTML_MESSAGE_BOX::AddHTML_Text(), HTML_MESSAGE_BOX::MessageSet(), and PopError().

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

◆ GetCount()

unsigned FOOTPRINT_LIST::GetCount ( ) const

inline

Returns: the number of items stored in list

Definition at line 186 of file footprint_info.h.

  {
  return m_list.size();
  }

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

◆ GetErrorCount()

unsigned FOOTPRINT_LIST::GetErrorCount ( ) const

inline

Definition at line 227 of file footprint_info.h.

  {
  return m_errors.size();
  }

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

◆ GetFootprintInfo() [1/2]

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

Get info for a footprint by id.

Definition at line 58 of file footprint_info.cpp.

 {
  if( aFootprintName.IsEmpty() )
  return nullptr;
 
  LIB_ID fpid;
 
  wxCHECK_MSG( fpid.Parse( aFootprintName ) < 0, nullptr,
  wxString::Format( wxT( "'%s' is not a valid LIB_ID." ), aFootprintName ) );
 
  return GetFootprintInfo( fpid.GetLibNickname(), fpid.GetLibItemName() );
 }

References Format(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), and LIB_ID::Parse().

Referenced by CVPCB_MAINFRAME::AutomaticFootprintMatching(), CVPCB_MAINFRAME::DisplayStatus(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ GetFootprintInfo() [2/2]

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

Get info for a footprint by libNickname/footprintName.

Definition at line 42 of file footprint_info.cpp.

 {
  if( aFootprintName.IsEmpty() )
  return nullptr;
 
  for( std::unique_ptr<FOOTPRINT_INFO>& fp : m_list )
  {
  if( aLibNickname == fp->GetLibNickname() && aFootprintName == fp->GetFootprintName() )
  return fp.get();
  }
 
  return nullptr;
 }

References m_list.

◆ GetInstance()

FOOTPRINT_LIST * FOOTPRINT_LIST::GetInstance ( KIWAY & aKiway )

static

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 143 of file footprint_info.cpp.

 {
  FOOTPRINT_LIST* footprintInfo = get_instance_from_id( aKiway, KIFACE_FOOTPRINT_LIST );
 
  if( !footprintInfo )
  return nullptr;
 
  if( !footprintInfo->GetCount() )
  footprintInfo->ReadCacheFromFile( aKiway.Prj().GetProjectPath() + wxT( "fp-info-cache" ) );
 
  return footprintInfo;
 }

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

Referenced by DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), FOOTPRINT_SELECT_WIDGET::Load(), and FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList().

◆ GetItem()

FOOTPRINT_INFO& FOOTPRINT_LIST::GetItem ( unsigned aIdx ) const

inline

Get info for a footprint by index.

Parameters

aIdx	index of the given item.

Returns: the aIdx item in list.

Definition at line 222 of file footprint_info.h.

  {
  return *m_list[aIdx];
  }

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

◆ GetList()

const FPILIST& FOOTPRINT_LIST::GetList ( ) const

inline

Was forced to add this by modview_frame.cpp.

Definition at line 192 of file footprint_info.h.

  {
  return m_list;
  }

Referenced by FP_TREE_MODEL_ADAPTER::getFootprints().

◆ GetTable()

FP_LIB_TABLE* FOOTPRINT_LIST::GetTable ( ) const

inline

Definition at line 257 of file footprint_info.h.

  {
  return m_lib_table;
  }

Referenced by FOOTPRINT_INFO_IMPL::load().

◆ joinWorkers()

virtual bool FOOTPRINT_LIST::joinWorkers ( )

protectedpure virtual

Join worker threads.

Part of the FOOTPRINT_ASYNC_LOADER implementation.

Implemented in FOOTPRINT_LIST_IMPL.

Referenced by FOOTPRINT_ASYNC_LOADER::Join().

◆ PopError()

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

inline

Definition at line 232 of file footprint_info.h.

  {
  std::unique_ptr<IO_ERROR> error;
 
  m_errors.pop( error );
  return error;
  }

Referenced by DisplayErrors().

◆ ReadCacheFromFile()

virtual void FOOTPRINT_LIST::ReadCacheFromFile ( const wxString & aFilePath )

inlinevirtual

Reimplemented in FOOTPRINT_LIST_IMPL.

Definition at line 181 of file footprint_info.h.

181 {};

Referenced by GetInstance().

◆ ReadFootprintFiles()

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

pure virtual

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.

Implemented in FOOTPRINT_LIST_IMPL.

Referenced by CVPCB_MAINFRAME::LoadFootprintFiles().

◆ startWorkers()

virtual void FOOTPRINT_LIST::startWorkers	(	FP_LIB_TABLE *	aTable,
		const wxString *	aNickname,
		FOOTPRINT_ASYNC_LOADER *	aLoader,
		unsigned	aNThreads
	)

protectedpure virtual

Launch worker threads to load footprints.

Part of the FOOTPRINT_ASYNC_LOADER implementation.

Implemented in FOOTPRINT_LIST_IMPL.

Referenced by FOOTPRINT_ASYNC_LOADER::Start().

◆ stopWorkers()

virtual void FOOTPRINT_LIST::stopWorkers ( )

protectedpure virtual

Stop worker threads.

Part of the FOOTPRINT_ASYNC_LOADER implementation.

Implemented in FOOTPRINT_LIST_IMPL.

Referenced by FOOTPRINT_ASYNC_LOADER::Abort().

◆ WriteCacheToFile()

virtual void FOOTPRINT_LIST::WriteCacheToFile ( const wxString & aFilePath )

inlinevirtual

Reimplemented in FOOTPRINT_LIST_IMPL.

Definition at line 180 of file footprint_info.h.

180 {};

Friends And Related Function Documentation

◆ FOOTPRINT_ASYNC_LOADER

friend class FOOTPRINT_ASYNC_LOADER

friend

Definition at line 290 of file footprint_info.h.

Member Data Documentation

◆ m_errors

ERRLIST FOOTPRINT_LIST::m_errors

protected

some can be PARSE_ERRORs also

Definition at line 296 of file footprint_info.h.

Referenced by FOOTPRINT_LIST_IMPL::CatchErrors(), FOOTPRINT_LIST_IMPL::joinWorkers(), FOOTPRINT_LIST_IMPL::ReadFootprintFiles(), and FOOTPRINT_LIST_IMPL::startWorkers().

◆ m_lib_table

FP_LIB_TABLE* FOOTPRINT_LIST::m_lib_table

protected

no ownership

Definition at line 293 of file footprint_info.h.

Referenced by FOOTPRINT_LIST_IMPL::joinWorkers(), FOOTPRINT_LIST_IMPL::loader_job(), and FOOTPRINT_LIST_IMPL::startWorkers().

◆ m_list

FPILIST FOOTPRINT_LIST::m_list

protected

Definition at line 295 of file footprint_info.h.

Referenced by GetFootprintInfo(), FOOTPRINT_FILTER::ITERATOR::increment(), FOOTPRINT_LIST_IMPL::joinWorkers(), FOOTPRINT_LIST_IMPL::ReadCacheFromFile(), FOOTPRINT_LIST_IMPL::startWorkers(), and FOOTPRINT_LIST_IMPL::WriteCacheToFile().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ERRLIST

◆ FPILIST

Constructor & Destructor Documentation

◆ FOOTPRINT_LIST()

◆ ~FOOTPRINT_LIST()

Member Function Documentation

◆ Clear()

◆ DisplayErrors()

◆ GetCount()

◆ GetErrorCount()

◆ GetFootprintInfo() [1/2]

◆ GetFootprintInfo() [2/2]

◆ GetInstance()

◆ GetItem()

◆ GetList()

◆ GetTable()

◆ joinWorkers()

◆ PopError()

◆ ReadCacheFromFile()

◆ ReadFootprintFiles()

◆ startWorkers()

◆ stopWorkers()

◆ WriteCacheToFile()

Friends And Related Function Documentation

◆ FOOTPRINT_ASYNC_LOADER

Member Data Documentation

◆ m_errors

◆ m_lib_table

◆ m_list