LIBRARY_TRAVERSER Class Reference

Traverser implementation that looks to find any and all "folder" libraries by looking for files with a specific extension inside folders. More...

Inheritance diagram for LIBRARY_TRAVERSER:

Public Member Functions
	LIBRARY_TRAVERSER (wxString aSearchExtension, wxString aInitialDir)
virtual wxDirTraverseResult	OnFile (const wxString &aFileName) override
virtual wxDirTraverseResult	OnOpenError (const wxString &aOpenErrorName) override
bool	HasDirectoryOpenFailures ()
virtual wxDirTraverseResult	OnDir (const wxString &aDirName) override
void	GetPaths (wxArrayString &aPathArray)
void	GetFailedPaths (wxArrayString &aPathArray)

Private Attributes
wxString	m_searchExtension
wxString	m_currentDir
std::unordered_map< wxString, int >	m_foundDirs
std::unordered_map< wxString, int >	m_failedDirs

Detailed Description

Traverser implementation that looks to find any and all "folder" libraries by looking for files with a specific extension inside folders.

Definition at line 141 of file panel_fp_lib_table.cpp.

Constructor & Destructor Documentation

LIBRARY_TRAVERSER()

LIBRARY_TRAVERSER::LIBRARY_TRAVERSER ( wxString  aSearchExtension, wxString  aInitialDir  )

inline

Definition at line 144 of file panel_fp_lib_table.cpp.

 : m_searchExtension( aSearchExtension ),
 m_currentDir( aInitialDir )
 {
 }

Member Function Documentation

GetFailedPaths()

void LIBRARY_TRAVERSER::GetFailedPaths ( wxArrayString &  aPathArray )

inline

Definition at line 183 of file panel_fp_lib_table.cpp.

 {
 for( std::pair<const wxString, int>& failedDirsPair : m_failedDirs )
 aPathArray.Add( failedDirsPair.first );
 }

References m_failedDirs.

GetPaths()

void LIBRARY_TRAVERSER::GetPaths ( wxArrayString &  aPathArray )

inline

Definition at line 177 of file panel_fp_lib_table.cpp.

 {
 for( std::pair<const wxString, int>& foundDirsPair : m_foundDirs )
 aPathArray.Add( foundDirsPair.first );
 }

References m_foundDirs.

Referenced by PANEL_FP_LIB_TABLE::browseLibrariesHandler().

HasDirectoryOpenFailures()

bool LIBRARY_TRAVERSER::HasDirectoryOpenFailures ( )

inline

Definition at line 166 of file panel_fp_lib_table.cpp.

 {
 return m_failedDirs.size() > 0;
 }

References m_failedDirs.

OnDir()

virtual wxDirTraverseResult LIBRARY_TRAVERSER::OnDir ( const wxString &  aDirName )

inlineoverridevirtual

Definition at line 171 of file panel_fp_lib_table.cpp.

 {
 m_currentDir = aDirName;
 return wxDIR_CONTINUE;
 }

References m_currentDir.

OnFile()

virtual wxDirTraverseResult LIBRARY_TRAVERSER::OnFile ( const wxString &  aFileName )

inlineoverridevirtual

Definition at line 150 of file panel_fp_lib_table.cpp.

 {
 wxFileName file( aFileName );

 if( m_searchExtension.IsSameAs( file.GetExt(), false ) )
 m_foundDirs.insert( { m_currentDir, 1 } );

 return wxDIR_CONTINUE;
 }

References m_currentDir, m_foundDirs, and m_searchExtension.

OnOpenError()

virtual wxDirTraverseResult LIBRARY_TRAVERSER::OnOpenError ( const wxString &  aOpenErrorName )

inlineoverridevirtual

Definition at line 160 of file panel_fp_lib_table.cpp.

 {
 m_failedDirs.insert( { aOpenErrorName, 1 } );
 return wxDIR_IGNORE;
 }

References m_failedDirs.

Member Data Documentation

m_currentDir

wxString LIBRARY_TRAVERSER::m_currentDir

private

Definition at line 191 of file panel_fp_lib_table.cpp.

Referenced by OnDir(), and OnFile().

m_failedDirs

std::unordered_map<wxString, int> LIBRARY_TRAVERSER::m_failedDirs

private

Definition at line 193 of file panel_fp_lib_table.cpp.

Referenced by GetFailedPaths(), HasDirectoryOpenFailures(), and OnOpenError().

m_foundDirs

std::unordered_map<wxString, int> LIBRARY_TRAVERSER::m_foundDirs

private

Definition at line 192 of file panel_fp_lib_table.cpp.

Referenced by GetPaths(), and OnFile().

m_searchExtension

wxString LIBRARY_TRAVERSER::m_searchExtension

private

Definition at line 190 of file panel_fp_lib_table.cpp.

Referenced by OnFile().

---

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

• panel_fp_lib_table.cpp