Refactored to use new generic plugin base
This commit is contained in:
Cirilo Bernardo
@@ -0,0 +1,438 @@
|
||||
/*
|
||||
* This program source code file is part of KiCad, a free EDA CAD application.
|
||||
*
|
||||
* Copyright (C) 2015 Cirilo Bernardo <[email protected]>
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU General Public License
|
||||
* as published by the Free Software Foundation; either version 2
|
||||
* of the License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, you may find one here:
|
||||
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
||||
* or you may search the http://www.gnu.org website for the version 2 license,
|
||||
* or you may write to the Free Software Foundation, Inc.,
|
||||
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
||||
*/
|
||||
|
||||
|
||||
#ifdef _WIN32
|
||||
#include <windows.h>
|
||||
#else
|
||||
#include <dlfcn.h>
|
||||
#include <pwd.h>
|
||||
#endif
|
||||
|
||||
#include <sstream>
|
||||
#include <iostream>
|
||||
|
||||
#include "pluginldr.h"
|
||||
|
||||
|
||||
KICAD_PLUGIN_LDR::KICAD_PLUGIN_LDR()
|
||||
{
|
||||
ok = false;
|
||||
m_getPluginClass = NULL;
|
||||
m_getClassVersion = NULL;
|
||||
m_checkClassVersion = NULL;
|
||||
m_getPluginName = NULL;
|
||||
m_getVersion = NULL;
|
||||
m_dlHandle = NULL;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
KICAD_PLUGIN_LDR::~KICAD_PLUGIN_LDR()
|
||||
{
|
||||
close();
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
bool KICAD_PLUGIN_LDR::open( const wxString& aFullFileName, const char* aPluginClass )
|
||||
{
|
||||
m_error.clear();
|
||||
|
||||
if( ok )
|
||||
Close();
|
||||
|
||||
if( aFullFileName.empty() )
|
||||
return false;
|
||||
|
||||
m_fileName.clear();
|
||||
|
||||
#ifdef _WIN32
|
||||
// NOTE: MSWin uses UTF-16 encoding
|
||||
#if defined( UNICODE ) || defined( _UNICODE )
|
||||
m_dlHandle = LoadLibrary( aFullFileName.wc_str() );
|
||||
#else
|
||||
m_dlHandle = LoadLibrary( aFullFileName.ToUTF8() );
|
||||
#endif
|
||||
#else
|
||||
m_dlHandle = dlopen( aFullFileName.ToUTF8(), RTLD_LAZY | RTLD_LOCAL );
|
||||
#endif
|
||||
|
||||
if( NULL == m_dlHandle )
|
||||
{
|
||||
#ifdef DEBUG
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * could not open file: '" << aFullFileName.ToUTF8() << "'\n";
|
||||
#endif
|
||||
return false;
|
||||
}
|
||||
|
||||
LINK_ITEM( m_getPluginClass, GET_PLUGIN_CLASS, "GetKicadPluginClass" );
|
||||
LINK_ITEM( m_getClassVersion, GET_CLASS_VERSION, "GetClassVersion" );
|
||||
LINK_ITEM( m_checkClassVersion, CHECK_CLASS_VERSION , "CheckClassVersion" );
|
||||
LINK_ITEM( m_getPluginName, GET_PLUGIN_NAME, "GetKicadPluginName" );
|
||||
LINK_ITEM( m_getVersion, GET_VERSION, "GetVersion" );
|
||||
|
||||
#ifdef DEBUG
|
||||
bool fail = false;
|
||||
|
||||
if( !m_getPluginClass )
|
||||
{
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * incompatible plugin: " << aFullFileName.ToUTF8() << "\n";
|
||||
std::cerr << " * missing function: GetKicadPluginClass\n";
|
||||
fail = true;
|
||||
}
|
||||
|
||||
if( !m_getClassVersion )
|
||||
{
|
||||
if( !fail )
|
||||
{
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * incompatible plugin: " << aFullFileName.ToUTF8() << "\n";
|
||||
fail = true;
|
||||
}
|
||||
|
||||
std::cerr << " * missing function: GetClassVersion\n";
|
||||
}
|
||||
|
||||
if( !m_checkClassVersion )
|
||||
{
|
||||
if( !fail )
|
||||
{
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * incompatible plugin: " << aFullFileName.ToUTF8() << "\n";
|
||||
fail = true;
|
||||
}
|
||||
|
||||
std::cerr << " * missing function: CheckClassVersion\n";
|
||||
}
|
||||
|
||||
if( !m_getPluginName )
|
||||
{
|
||||
if( !fail )
|
||||
{
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * incompatible plugin: " << aFullFileName.ToUTF8() << "\n";
|
||||
fail = true;
|
||||
}
|
||||
|
||||
std::cerr << " * missing function: GetKicadPluginName\n";
|
||||
}
|
||||
|
||||
if( !m_getVersion )
|
||||
{
|
||||
if( !fail )
|
||||
{
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * incompatible plugin: " << aFullFileName.ToUTF8() << "\n";
|
||||
}
|
||||
|
||||
std::cerr << " * missing function: GetVersion\n";
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
if( !m_getPluginClass || !m_getClassVersion || !m_checkClassVersion
|
||||
|| !m_getPluginName || !m_getVersion )
|
||||
{
|
||||
m_error = "incompatible plugin interface (missing functions)";
|
||||
close();
|
||||
return false;
|
||||
}
|
||||
|
||||
// note: since 'ok' is not yet set at this point we must use the function
|
||||
// pointers directly rather than invoking the functions exposed by this class
|
||||
|
||||
// check that the Plugin Class matches
|
||||
char const* pclassName = m_getPluginClass();
|
||||
|
||||
if( !pclassName || strcmp( aPluginClass, pclassName ) )
|
||||
{
|
||||
m_error = "Loader type (";
|
||||
m_error.append( aPluginClass );
|
||||
m_error.append( ") does not match Plugin type (" );
|
||||
|
||||
if( pclassName )
|
||||
m_error.append( pclassName );
|
||||
else
|
||||
m_error.append( "NULL" );
|
||||
|
||||
m_error.append( ")" );
|
||||
|
||||
close();
|
||||
return false;
|
||||
}
|
||||
|
||||
// perform a universally enforced version check (major number must match)
|
||||
unsigned char lMajor;
|
||||
unsigned char lMinor;
|
||||
unsigned char lRevno;
|
||||
unsigned char lPatch;
|
||||
unsigned char pMajor;
|
||||
unsigned char pMinor;
|
||||
unsigned char pRevno;
|
||||
unsigned char pPatch;
|
||||
|
||||
m_getClassVersion( &pMajor, &pMinor, &pRevno, &pPatch );
|
||||
GetLoaderVersion( &lMajor, &lMinor, &lRevno, &lPatch );
|
||||
|
||||
// major version changes by definition are incompatible and
|
||||
// that is enforced here.
|
||||
if( pMajor != lMajor )
|
||||
{
|
||||
std::ostringstream ostr;
|
||||
ostr << "Loader Major version (" << lMajor;
|
||||
ostr << ") does not match Plugin Major version (" << pMajor << ")";
|
||||
|
||||
m_error = ostr.str();
|
||||
close();
|
||||
return false;
|
||||
}
|
||||
|
||||
if( !m_checkClassVersion( lMajor, lMinor, lRevno, lPatch ) )
|
||||
{
|
||||
std::ostringstream ostr;
|
||||
ostr << "Plugin Version (" << pMajor << "." << pMinor << "." << pRevno << "." << pPatch;
|
||||
ostr << ") does not support Loader Version (" << pMajor << "." << pMinor;
|
||||
ostr << "." << pRevno << "." << pPatch << ")";
|
||||
|
||||
m_error = ostr.str();
|
||||
close();
|
||||
return false;
|
||||
}
|
||||
|
||||
m_fileName = aFullFileName;
|
||||
|
||||
#ifdef DEBUG
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * [INFO] opened plugin " << m_fileName.ToUTF8() << "\n";
|
||||
char const* cp = m_getPluginName();
|
||||
if( !cp )
|
||||
std::cerr << " * [INFO] plugin name: '" << cp << "'\n";
|
||||
#endif
|
||||
|
||||
ok = true;
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
void KICAD_PLUGIN_LDR::close( void )
|
||||
{
|
||||
ok = false;
|
||||
m_getPluginClass = NULL;
|
||||
m_getClassVersion = NULL;
|
||||
m_checkClassVersion = NULL;
|
||||
m_getPluginName = NULL;
|
||||
m_getVersion = NULL;
|
||||
|
||||
if( NULL != m_dlHandle )
|
||||
{
|
||||
|
||||
#ifdef _WIN32
|
||||
FreeLibrary( m_dlHandle );
|
||||
#else
|
||||
dlclose( m_dlHandle );
|
||||
#endif
|
||||
|
||||
m_dlHandle = NULL;
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
bool KICAD_PLUGIN_LDR::reopen( void )
|
||||
{
|
||||
m_error.clear();
|
||||
|
||||
if( m_fileName.empty() )
|
||||
return false;
|
||||
|
||||
wxString fname = m_fileName;
|
||||
|
||||
return Open( fname );
|
||||
}
|
||||
|
||||
|
||||
std::string KICAD_PLUGIN_LDR::GetLastError( void ) const
|
||||
{
|
||||
return m_error;
|
||||
}
|
||||
|
||||
|
||||
char const* KICAD_PLUGIN_LDR::GetKicadPluginClass( void )
|
||||
{
|
||||
m_error.clear();
|
||||
|
||||
if( !ok && !reopen() )
|
||||
{
|
||||
if( m_error.empty() )
|
||||
m_error = "[INFO] no open plugin / plugin could not be opened";
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
if( NULL == m_getPluginClass )
|
||||
{
|
||||
m_error = "[BUG] GetPluginClass is not linked";
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * " << m_error << "\n";
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return m_getPluginClass();
|
||||
}
|
||||
|
||||
|
||||
bool KICAD_PLUGIN_LDR::GetClassVersion( unsigned char* Major, unsigned char* Minor,
|
||||
unsigned char* Revision, unsigned char* Patch )
|
||||
{
|
||||
m_error.clear();
|
||||
|
||||
if( Major )
|
||||
*Major = 0;
|
||||
|
||||
if( Minor )
|
||||
*Minor = 0;
|
||||
|
||||
if( Revision )
|
||||
*Revision = 0;
|
||||
|
||||
if( Patch )
|
||||
*Patch = 0;
|
||||
|
||||
unsigned char major;
|
||||
unsigned char minor;
|
||||
unsigned char revno;
|
||||
unsigned char patch;
|
||||
|
||||
if( !ok && !reopen() )
|
||||
{
|
||||
if( m_error.empty() )
|
||||
m_error = "[INFO] no open plugin / plugin could not be opened";
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
if( NULL == m_checkClassVersion )
|
||||
{
|
||||
m_error = "[BUG] CheckClassVersion is not linked";
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * " << m_error << "\n";
|
||||
return false;
|
||||
}
|
||||
|
||||
m_getClassVersion( &major, &minor, &revno, &patch );
|
||||
|
||||
if( Major )
|
||||
*Major = major;
|
||||
|
||||
if( Minor )
|
||||
*Minor = minor;
|
||||
|
||||
if( Revision )
|
||||
*Revision = revno;
|
||||
|
||||
if( Patch )
|
||||
*Patch = patch;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
bool KICAD_PLUGIN_LDR::CheckClassVersion( unsigned char Major, unsigned char Minor,
|
||||
unsigned char Revision, unsigned char Patch )
|
||||
{
|
||||
m_error.clear();
|
||||
|
||||
if( !ok && !reopen() )
|
||||
{
|
||||
if( m_error.empty() )
|
||||
m_error = "[INFO] no open plugin / plugin could not be opened";
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
if( NULL == m_checkClassVersion )
|
||||
{
|
||||
m_error = "[BUG] CheckClassVersion is not linked";
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * " << m_error << "\n";
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return m_checkClassVersion( Major, Minor, Revision, Patch );
|
||||
}
|
||||
|
||||
|
||||
const char* KICAD_PLUGIN_LDR::GetKicadPluginName( void )
|
||||
{
|
||||
m_error.clear();
|
||||
|
||||
if( !ok && !reopen() )
|
||||
{
|
||||
if( m_error.empty() )
|
||||
m_error = "[INFO] no open plugin / plugin could not be opened";
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
if( NULL == m_getPluginName )
|
||||
{
|
||||
m_error = "[BUG] GetKicadPluginName is not linked";
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * " << m_error << "\n";
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return m_getPluginName();
|
||||
}
|
||||
|
||||
|
||||
bool KICAD_PLUGIN_LDR::GetVersion( unsigned char* Major, unsigned char* Minor,
|
||||
unsigned char* Revision, unsigned char* Patch )
|
||||
{
|
||||
m_error.clear();
|
||||
|
||||
if( !ok && !reopen() )
|
||||
{
|
||||
if( m_error.empty() )
|
||||
m_error = "[INFO] no open plugin / plugin could not be opened";
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
if( NULL == m_getVersion )
|
||||
{
|
||||
m_error = "[BUG] GetKicadPluginName is not linked";
|
||||
std::cerr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
||||
std::cerr << " * " << m_error << "\n";
|
||||
return false;
|
||||
}
|
||||
|
||||
m_getVersion( Major, Minor, Revision, Patch );
|
||||
|
||||
return true;
|
||||
}
|
||||
Reference in New Issue
Block a user