S3D_PLUGIN_MANAGER Class Reference

#include <3d_plugin_manager.h>

Public Member Functions
	S3D_PLUGIN_MANAGER ()
virtual	~S3D_PLUGIN_MANAGER ()
std::list< wxString > const *	GetFileFilters (void) const noexcept
	Return the list of file filters; this will contain at least the default "All Files (*.*)|*.*" and the file filters supported by any available plugins. More...
SCENEGRAPH *	Load3DModel (const wxString &aFileName, std::string &aPluginInfo)
void	ClosePlugins (void)
	Iterate through all discovered plugins and closes them to reclaim memory. More...
bool	CheckTag (const char *aTag)
	Check the given tag and returns true if the plugin named in the tag is not loaded or the plugin is loaded and the version matches. More...

Private Member Functions
void	loadPlugins (void)
	load plugins More...
void	listPlugins (const wxString &aPath, std::list< wxString > &aPluginList)
	list potential plugins More...
void	checkPluginName (const wxString &aPath, std::list< wxString > &aPluginList)
	check the existence of a plugin name and add it to the list More...
void	checkPluginPath (const wxString &aPath, std::list< wxString > &aSearchList)
	check the existence of a path and add it to the path search list More...
void	addFilterString (const wxString &aFilterString)
	add an entry to the file filter list More...
void	addExtensionMap (KICAD_PLUGIN_LDR_3D *aPlugin)
	add entries to the extension map More...

Private Attributes
std::list< KICAD_PLUGIN_LDR_3D * >	m_Plugins
	list of discovered plugins More...
std::multimap< const wxString, KICAD_PLUGIN_LDR_3D * >	m_ExtMap
	mapping of extensions to available plugins More...
std::list< wxString >	m_FileFilters
	list of file filters More...

Detailed Description

Definition at line 42 of file 3d_plugin_manager.h.

Constructor & Destructor Documentation

S3D_PLUGIN_MANAGER()

S3D_PLUGIN_MANAGER::S3D_PLUGIN_MANAGER

(

)

Definition at line 55 of file 3d_plugin_manager.cpp.

{
 // create the initial file filter list entry
 m_FileFilters.emplace_back( _( "All Files" ) + wxT( " (*.*)|*.*" ) );
 
 // discover and load plugins
 loadPlugins();
 
#ifdef DEBUG
 if( !m_ExtMap.empty() )
 {
 std::multimap< const wxString, KICAD_PLUGIN_LDR_3D* >::const_iterator sM = m_ExtMap.begin();
 std::multimap< const wxString, KICAD_PLUGIN_LDR_3D* >::const_iterator eM = m_ExtMap.end();
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( " * Extension [plugin name]:\n" ) );
 
 while( sM != eM )
 {
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( " + '%s' [%s]\n" ), sM->first.GetData(),
 sM->second->GetKicadPluginName() );
 ++sM;
 }
 
 }
 else
 {
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( " * No plugins available\n" ) );
 }
 
 
 if( !m_FileFilters.empty() )
 {
 std::list< wxString >::const_iterator sFF = m_FileFilters.begin();
 std::list< wxString >::const_iterator eFF = m_FileFilters.end();
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( " * File filters:\n" ) );
 
 while( sFF != eFF )
 {
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( " + '%s'\n" ), (*sFF).GetData() );
 ++sFF;
 }
 }
 else
 {
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( " * No file filters available\n" ) );
 }
#endif // DEBUG
}

References _, loadPlugins(), m_ExtMap, m_FileFilters, and MASK_3D_PLUGINMGR.

~S3D_PLUGIN_MANAGER()

S3D_PLUGIN_MANAGER::~S3D_PLUGIN_MANAGER ( )

virtual

Definition at line 105 of file 3d_plugin_manager.cpp.

{
 std::list< KICAD_PLUGIN_LDR_3D* >::iterator sP = m_Plugins.begin();
 std::list< KICAD_PLUGIN_LDR_3D* >::iterator eP = m_Plugins.end();
 
 while( sP != eP )
 {
 (*sP)->Close();
 delete *sP;
 ++sP;
 }
 
 m_Plugins.clear();
}

References m_Plugins.

Member Function Documentation

addExtensionMap()

void S3D_PLUGIN_MANAGER::addExtensionMap ( KICAD_PLUGIN_LDR_3D *  aPlugin )

private

add entries to the extension map

Definition at line 358 of file 3d_plugin_manager.cpp.

{
 // add entries to the extension map
 if( nullptr == aPlugin )
 return;
 
 int nExt = aPlugin->GetNExtensions();
 
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( "%s:%s:%d * [INFO] adding %d extensions" ),
 __FILE__, __FUNCTION__, __LINE__, nExt );
 
 for( int i = 0; i < nExt; ++i )
 {
 char const* cp = aPlugin->GetModelExtension( i );
 wxString ws;
 
 if( cp )
 ws = wxString::FromUTF8Unchecked( cp );
 
 if( !ws.empty() )
 {
 m_ExtMap.emplace( ws, aPlugin );
 }
 
 }
}

References KICAD_PLUGIN_LDR_3D::GetModelExtension(), KICAD_PLUGIN_LDR_3D::GetNExtensions(), m_ExtMap, and MASK_3D_PLUGINMGR.

Referenced by loadPlugins().

addFilterString()

void S3D_PLUGIN_MANAGER::addFilterString ( const wxString &  aFilterString )

private

add an entry to the file filter list

Definition at line 336 of file 3d_plugin_manager.cpp.

{
 // add an entry to the file filter list
 if( aFilterString.empty() )
 return;
 
 std::list< wxString >::iterator sFF = m_FileFilters.begin();
 std::list< wxString >::iterator eFF = m_FileFilters.end();
 
 while( sFF != eFF )
 {
 if( 0 == (*sFF).Cmp( aFilterString ) )
 return;
 
 ++sFF;
 }
 
 m_FileFilters.push_back( aFilterString );
 return;
}

References m_FileFilters.

Referenced by loadPlugins().

checkPluginName()

void S3D_PLUGIN_MANAGER::checkPluginName ( const wxString &  aPath, std::list< wxString > &  aPluginList  )

private

check the existence of a plugin name and add it to the list

Definition at line 272 of file 3d_plugin_manager.cpp.

{
 // check the existence of a plugin name and add it to the list
 
 if( aPath.empty() || !wxFileName::FileExists( aPath ) )
 return;
 
 wxFileName path( ExpandEnvVarSubstitutions( aPath, nullptr ) );
 
 path.Normalize( FN_NORMALIZE_FLAGS );
 
 // determine if the path is already in the list
 wxString wxpath = path.GetFullPath();
 std::list< wxString >::iterator bl = aPluginList.begin();
 std::list< wxString >::iterator el = aPluginList.end();
 
 while( bl != el )
 {
 if( 0 == (*bl).Cmp( wxpath ) )
 return;
 
 ++bl;
 }
 
 aPluginList.push_back( wxpath );
 
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( " * [INFO] found 3D plugin '%s'\n" ), wxpath.GetData() );
}

References ExpandEnvVarSubstitutions(), FN_NORMALIZE_FLAGS, MASK_3D_PLUGINMGR, and path.

Referenced by listPlugins().

checkPluginPath()

void S3D_PLUGIN_MANAGER::checkPluginPath ( const wxString &  aPath, std::list< wxString > &  aSearchList  )

private

check the existence of a path and add it to the path search list

Definition at line 303 of file 3d_plugin_manager.cpp.

{
 if( aPath.empty() )
 return;
 
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( " * [INFO] checking if valid plugin directory '%s'\n" ),
 aPath.GetData() );
 
 wxFileName path;
 path.AssignDir( aPath );
 path.Normalize( FN_NORMALIZE_FLAGS );
 
 if( !wxFileName::DirExists( path.GetFullPath() ) )
 return;
 
 // determine if the directory is already in the list
 wxString wxpath = path.GetFullPath();
 std::list< wxString >::iterator bl = aSearchList.begin();
 std::list< wxString >::iterator el = aSearchList.end();
 
 while( bl != el )
 {
 if( 0 == (*bl).Cmp( wxpath ) )
 return;
 
 ++bl;
 }
 
 aSearchList.push_back( wxpath );
}

References FN_NORMALIZE_FLAGS, MASK_3D_PLUGINMGR, and path.

Referenced by loadPlugins().

CheckTag()

bool S3D_PLUGIN_MANAGER::CheckTag

(

const char *

aTag

)

Check the given tag and returns true if the plugin named in the tag is not loaded or the plugin is loaded and the version matches.

Definition at line 452 of file 3d_plugin_manager.cpp.

{
 if( nullptr == aTag || aTag[0] == 0 || m_Plugins.empty() )
 return false;
 
 std::string tname = aTag;
 std::string pname; // plugin name
 
 size_t cpos = tname.find( ':' );
 
 // if there is no colon or plugin name then the tag is bad
 if( cpos == std::string::npos || cpos == 0 )
 return false;
 
 pname = tname.substr( 0, cpos );
 std::string ptag; // tag from the plugin
 
 std::list< KICAD_PLUGIN_LDR_3D* >::iterator pS = m_Plugins.begin();
 std::list< KICAD_PLUGIN_LDR_3D* >::iterator pE = m_Plugins.end();
 
 while( pS != pE )
 {
 ptag.clear();
 (*pS)->GetPluginInfo( ptag );
 
 // if the plugin name matches then the version
 // must also match
 if( !ptag.compare( 0, pname.size(), pname ) )
 {
 if( ptag.compare( tname ) )
 return false;
 
 return true;
 }
 
 ++pS;
 }
 
 return true;
}

References m_Plugins.

Referenced by checkTag().

ClosePlugins()

void S3D_PLUGIN_MANAGER::ClosePlugins

(

void

)

Iterate through all discovered plugins and closes them to reclaim memory.

The individual plugins will be automatically reloaded as calls are made to load specific models.

Definition at line 436 of file 3d_plugin_manager.cpp.

{
 std::list< KICAD_PLUGIN_LDR_3D* >::iterator sP = m_Plugins.begin();
 std::list< KICAD_PLUGIN_LDR_3D* >::iterator eP = m_Plugins.end();
 
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( "%s:%s:%d * [INFO] closing %d extensions" ),
 __FILE__, __FUNCTION__, __LINE__, static_cast<int>( m_Plugins.size() ) );
 
 while( sP != eP )
 {
 (*sP)->Close();
 ++sP;
 }
}

References m_Plugins, and MASK_3D_PLUGINMGR.

Referenced by S3D_CACHE::ClosePlugins().

GetFileFilters()

std::list< wxString > const * S3D_PLUGIN_MANAGER::GetFileFilters ( void  ) const

noexcept

Return the list of file filters; this will contain at least the default "All Files (*.*)|*.*" and the file filters supported by any available plugins.

Returns

a pointer to the internal filter list.

Definition at line 386 of file 3d_plugin_manager.cpp.

{
 return &m_FileFilters;
}

Referenced by S3D_CACHE::GetFileFilters().

listPlugins()

void S3D_PLUGIN_MANAGER::listPlugins ( const wxString &  aPath, std::list< wxString > &  aPluginList  )

private

list potential plugins

Definition at line 229 of file 3d_plugin_manager.cpp.

{
 // list potential plugins given a search path
 wxString nameFilter; // filter for user-loadable libraries (aka footprints)
 wxString lName; // stores name of enumerated files
 wxString fName; // full name of file
 wxDir wd;
 wd.Open( aPath );
 
 if( !wd.IsOpened() )
 return;
 
 nameFilter = wxT( "*" );
 
#ifndef __WXMAC__
 nameFilter.Append( wxDynamicLibrary::GetDllExt( wxDL_MODULE ) );
#else
 // wxDynamicLibrary::GetDllExt( wxDL_MODULE ) will return ".bundle" on OS X.
 // This might be correct, but cmake builds a ".so" for a library MODULE.
 // Per definition a loadable "xxx.bundle" is similar to an "xxx.app" app
 // bundle being a folder with some special content in it. We obviously don't
 // want to have that here for our loadable module, so just use ".so".
 nameFilter.Append( wxS( ".so" ) );
#endif
 
 wxString lp = wd.GetNameWithSep();
 
 if( wd.GetFirst( &lName, nameFilter, wxDIR_FILES ) )
 {
 fName = lp + lName;
 checkPluginName( fName, aPluginList );
 
 while( wd.GetNext( &lName ) )
 {
 fName = lp + lName;
 checkPluginName( fName, aPluginList );
 }
 }
 
 wd.Close();
}

References checkPluginName().

Referenced by loadPlugins().

Load3DModel()

SCENEGRAPH * S3D_PLUGIN_MANAGER::Load3DModel	(	const wxString &	aFileName,
		std::string &	aPluginInfo
	)

Definition at line 392 of file 3d_plugin_manager.cpp.

{
 wxFileName raw( aFileName );
 wxString ext_to_find = raw.GetExt();
 
#ifdef _WIN32
 // note: plugins only have a lowercase filter within Windows; including an uppercase
 // filter will result in duplicate file entries and should be avoided.
 ext_to_find.MakeLower();
#endif
 
 // .gz files are compressed versions that may have additional information in the previous extension
 if( ext_to_find == wxT( "gz" ) )
 {
 wxFileName second( raw.GetName() );
 ext_to_find = second.GetExt() + wxT( ".gz" );
 }
 
 std::pair < std::multimap< const wxString, KICAD_PLUGIN_LDR_3D* >::iterator,
 std::multimap< const wxString, KICAD_PLUGIN_LDR_3D* >::iterator > items;
 
 items = m_ExtMap.equal_range( ext_to_find );
 std::multimap< const wxString, KICAD_PLUGIN_LDR_3D* >::iterator sL = items.first;
 
 while( sL != items.second )
 {
 if( sL->second->CanRender() )
 {
 SCENEGRAPH* sp = sL->second->Load( aFileName.ToUTF8() );
 
 if( nullptr != sp )
 {
 sL->second->GetPluginInfo( aPluginInfo );
 return sp;
 }
 }
 
 ++sL;
 }
 
 return nullptr;
}

References m_ExtMap.

Referenced by S3D_CACHE::checkCache(), and S3D_CACHE::load().

loadPlugins()

void S3D_PLUGIN_MANAGER::loadPlugins ( void  )

private

load plugins

Definition at line 121 of file 3d_plugin_manager.cpp.

{
 std::list<wxString> searchpaths;
 std::list<wxString> pluginlist;
 wxFileName fn;
 
#ifndef __WXMAC__
 if( wxGetEnv( wxT( "KICAD_RUN_FROM_BUILD_DIR" ), nullptr ) )
 {
 // set up to work from the build directory
 fn.Assign( wxStandardPaths::Get().GetExecutablePath() );
 fn.AppendDir( wxT( ".." ) );
 fn.AppendDir( wxT( "plugins" ) );
 fn.AppendDir( wxT( "3d" ) );
 
 std::string testpath = std::string( fn.GetPathWithSep().ToUTF8() );
 checkPluginPath( testpath, searchpaths );
 
 // add subdirectories too
 wxDir debugPluginDir;
 wxString subdir;
 
 debugPluginDir.Open( testpath );
 
 if( debugPluginDir.IsOpened()
 && debugPluginDir.GetFirst( &subdir, wxEmptyString, wxDIR_DIRS ) )
 {
 checkPluginPath( testpath + subdir, searchpaths );
 
 while( debugPluginDir.GetNext( &subdir ) )
 checkPluginPath( testpath + subdir, searchpaths );
 }
 }
 
 fn.AssignDir( PATHS::GetStockPlugins3DPath() );
 checkPluginPath( std::string( fn.GetPathWithSep().ToUTF8() ), searchpaths );
#else
 // Search path on OS X is
 // (1) Machine /Library/Application Support/kicad/PlugIns/3d
 checkPluginPath( PATHS::GetOSXKicadMachineDataDir() + wxT( "/PlugIns/3d" ), searchpaths );
 
 // (2) Bundle kicad.app/Contents/PlugIns/3d
 fn.AssignDir( PATHS::GetStockPlugins3DPath() );
 checkPluginPath( fn.GetPathWithSep(), searchpaths );
#endif
 
 std::list< wxString >::iterator sPL = searchpaths.begin();
 std::list< wxString >::iterator ePL = searchpaths.end();
 
 while( sPL != ePL )
 {
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( "%s:%s:%d * [DEBUG] searching path: '%s'" ),
 __FILE__, __FUNCTION__, __LINE__, (*sPL).ToUTF8() );
 
 listPlugins( *sPL, pluginlist );
 ++sPL;
 }
 
 if( pluginlist.empty() )
 return;
 
 sPL = pluginlist.begin();
 ePL = pluginlist.end();
 
 while( sPL != ePL )
 {
 KICAD_PLUGIN_LDR_3D* pp = new KICAD_PLUGIN_LDR_3D;
 
 if( pp->Open( sPL->ToUTF8() ) )
 {
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( "%s:%s:%d * [DEBUG] adding plugin" ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 m_Plugins.push_back( pp );
 int nf = pp->GetNFilters();
 
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( "%s:%s:%d * [DEBUG] adding %d filters" ),
 __FILE__, __FUNCTION__, __LINE__, nf );
 
 for( int i = 0; i < nf; ++i )
 {
 char const* cp = pp->GetFileFilter( i );
 
 if( cp )
 addFilterString( wxString::FromUTF8Unchecked( cp ) );
 }
 
 addExtensionMap( pp );
 
 // close the loaded library
 pp->Close();
 }
 else
 {
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( "%s:%s:%d * [DEBUG] deleting plugin" ),
 __FILE__, __FUNCTION__, __LINE__ );
 
 delete pp;
 }
 
 ++sPL;
 }
 
 wxLogTrace( MASK_3D_PLUGINMGR, wxT( "%s:%s:%d * [DEBUG] plugins loaded" ),
 __FILE__, __FUNCTION__, __LINE__ );
}

References addExtensionMap(), addFilterString(), checkPluginPath(), KICAD_PLUGIN_LDR_3D::Close(), KICAD_PLUGIN_LDR_3D::GetFileFilter(), KICAD_PLUGIN_LDR_3D::GetNFilters(), PATHS::GetStockPlugins3DPath(), listPlugins(), m_Plugins, MASK_3D_PLUGINMGR, and KICAD_PLUGIN_LDR_3D::Open().

Referenced by S3D_PLUGIN_MANAGER().

Member Data Documentation

m_ExtMap

std::multimap< const wxString, KICAD_PLUGIN_LDR_3D* > S3D_PLUGIN_MANAGER::m_ExtMap

private

mapping of extensions to available plugins

Definition at line 95 of file 3d_plugin_manager.h.

Referenced by addExtensionMap(), Load3DModel(), and S3D_PLUGIN_MANAGER().

m_FileFilters

std::list< wxString > S3D_PLUGIN_MANAGER::m_FileFilters

private

list of file filters

Definition at line 98 of file 3d_plugin_manager.h.

Referenced by addFilterString(), and S3D_PLUGIN_MANAGER().

m_Plugins

std::list< KICAD_PLUGIN_LDR_3D* > S3D_PLUGIN_MANAGER::m_Plugins

private

list of discovered plugins

Definition at line 92 of file 3d_plugin_manager.h.

Referenced by CheckTag(), ClosePlugins(), loadPlugins(), and ~S3D_PLUGIN_MANAGER().

---

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

• 3d_plugin_manager.h
• 3d_plugin_manager.cpp