/////////////////////////////////////////////////////////////////////////////
-// Name: dynload.cpp
+// Name: src/common/dynload.cpp
// Purpose: Dynamic loading framework
// Author: Ron Lee, David Falkinder, Vadim Zeitlin and a cast of 1000's
// (derived in part from dynlib.cpp (c) 1998 Guilhem Lavaux)
// Created: 03/12/01
// RCS-ID: $Id$
// Copyright: (c) 2001 Ron Lee <ron@debian.org>
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "dynload.h"
-#endif
-
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
#ifndef WX_PRECOMP
#include "wx/log.h"
#include "wx/intl.h"
+ #include "wx/hash.h"
+ #include "wx/utils.h"
+ #include "wx/module.h"
#endif
-#include "wx/filename.h" // for SplitPath()
+#include "wx/strconv.h"
#include "wx/dynload.h"
-#if defined(__DARWIN__)
-/* Porting notes:
- * The dlopen port is a port from dl_next.xs by Anno Siegel.
- * dl_next.xs is itself a port from dl_dlopen.xs by Paul Marquess.
- * The method used here is just to supply the sun style dlopen etc.
- * functions in terms of Darwin NS*.
- */
-void *dlopen(const char *path, int mode /* mode is ignored */);
-void *dlsym(void *handle, const char *symbol);
-int dlclose(void *handle);
-const char *dlerror(void);
-#endif
-
-// ============================================================================
-// implementation
-// ============================================================================
// ---------------------------------------------------------------------------
-// wxDynamicLibrary
+// wxPluginLibrary
// ---------------------------------------------------------------------------
-//FIXME: This class isn't really common at all, it should be moved into
-// platform dependent files.
-#if defined(__WINDOWS__) || defined(__WXPM__) || defined(__EMX__)
-const wxString wxDynamicLibrary::ms_dllext( _T(".dll") );
-#elif defined(__UNIX__)
-#if defined(__HPUX__)
-const wxString wxDynamicLibrary::ms_dllext( _T(".sl") );
-#else
-const wxString wxDynamicLibrary::ms_dllext( _T(".so") );
-#endif
-#endif
-
-wxDllType wxDynamicLibrary::GetProgramHandle()
-{
-#if defined( HAVE_DLOPEN ) && !defined(__EMX__)
- return dlopen(0, RTLD_LAZY);
-#elif defined (HAVE_SHL_LOAD)
- return PROG_HANDLE;
-#else
- wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2"));
- return 0;
-#endif
-}
+wxDLImports* wxPluginLibrary::ms_classes = NULL;
-bool wxDynamicLibrary::Load(wxString libname, int flags)
+class wxPluginLibraryModule : public wxModule
{
- wxASSERT_MSG(m_handle == 0, _T("Library already loaded."));
+public:
+ wxPluginLibraryModule() { }
- // add the proper extension for the DLL ourselves unless told not to
- if ( !(flags & wxDL_VERBATIM) )
+ // TODO: create ms_classes on demand, why always preallocate it?
+ virtual bool OnInit()
{
- // and also check that the libname doesn't already have it
- wxString ext;
- wxFileName::SplitPath(libname, NULL, NULL, &ext);
- if ( ext.empty() )
- {
- libname += GetDllExt();
- }
+ wxPluginLibrary::ms_classes = new wxDLImports;
+ wxPluginManager::CreateManifest();
+ return true;
}
-#if defined(__WXMAC__) && !defined(__DARWIN__)
- FSSpec myFSSpec;
- Ptr myMainAddr;
- Str255 myErrName;
-
- wxMacFilename2FSSpec( libname , &myFSSpec );
-
- if( GetDiskFragment( &myFSSpec,
- 0,
- kCFragGoesToEOF,
- "\p",
- kPrivateCFragCopy,
- &m_handle,
- &myMainAddr,
- myErrName ) != noErr )
+ virtual void OnExit()
{
- p2cstr( myErrName );
- wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
- libname.c_str(),
- (char*)myErrName );
- m_handle = 0;
+ wxDELETE(wxPluginLibrary::ms_classes);
+ wxPluginManager::ClearManifest();
}
-#elif defined(__WXPM__) || defined(__EMX__)
- char err[256] = "";
- DosLoadModule(err, sizeof(err), libname.c_str(), &m_handle);
-
-#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
+private:
+ DECLARE_DYNAMIC_CLASS(wxPluginLibraryModule )
+};
-#if defined(__VMS) || defined(__DARWIN__)
- m_handle = dlopen(libname.c_str(), 0); // The second parameter is ignored
-#else
- int rtldFlags = 0;
+IMPLEMENT_DYNAMIC_CLASS(wxPluginLibraryModule, wxModule)
- if( flags & wxDL_LAZY )
- {
- wxASSERT_MSG( (flags & wxDL_NOW) == 0,
- _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") );
- rtldFlags |= RTLD_LAZY;
- }
- else if( flags & wxDL_NOW )
- {
- rtldFlags |= RTLD_NOW;
- }
- if( flags & wxDL_GLOBAL )
- {
-#ifdef __osf__
- wxLogDebug(_T("WARNING: RTLD_GLOBAL is not a supported on this platform."));
-#endif
- rtldFlags |= RTLD_GLOBAL;
- }
-
- m_handle = dlopen(libname.c_str(), rtldFlags);
-#endif // __VMS || __DARWIN__
-
-#elif defined(HAVE_SHL_LOAD)
- int shlFlags = 0;
-
- if( flags & wxDL_LAZY )
- {
- wxASSERT_MSG( (flags & wxDL_NOW) == 0,
- _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") );
- shlFlags |= BIND_DEFERRED;
- }
- else if( flags & wxDL_NOW )
- {
- shlFlags |= BIND_IMMEDIATE;
- }
- m_handle = shl_load(libname.c_str(), BIND_DEFERRED, 0);
-
-#elif defined(__WINDOWS__)
- m_handle = ::LoadLibrary(libname.c_str());
-
-#else
-#error "runtime shared lib support not implemented"
-#endif
-
- if ( m_handle == 0 )
- {
- wxString msg(_("Failed to load shared library '%s'"));
-#if defined(HAVE_DLERROR) && !defined(__EMX__)
- const wxChar *err = dlerror();
- if( err )
- wxLogError( msg, err );
-#else
- wxLogSysError( msg, libname.c_str() );
-#endif
- }
- return IsLoaded();
-}
-
-void wxDynamicLibrary::Unload()
-{
- if( IsLoaded() )
- {
-#if defined(__WXPM__) || defined(__EMX__)
- DosFreeModule( m_handle );
-#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
- dlclose( m_handle );
-#elif defined(HAVE_SHL_LOAD)
- shl_unload( m_handle );
-#elif defined(__WINDOWS__)
- ::FreeLibrary( m_handle );
-#elif defined(__WXMAC__) && !defined(__DARWIN__)
- CloseConnection( (CFragConnectionID*) &m_handle );
-#else
-#error "runtime shared lib support not implemented"
-#endif
- m_handle = 0;
- }
-}
-
-void *wxDynamicLibrary::GetSymbol(const wxString &name, bool *success) const
+wxPluginLibrary::wxPluginLibrary(const wxString &libname, int flags)
+ : m_linkcount(1)
+ , m_objcount(0)
{
- wxCHECK_MSG( IsLoaded(), NULL,
- _T("Can't load symbol from unloaded library") );
-
- bool failed = FALSE;
- void *symbol = 0;
-
-#if defined(__WXMAC__) && !defined(__DARWIN__)
- Ptr symAddress;
- CFragSymbolClass symClass;
- Str255 symName;
-#if TARGET_CARBON
- c2pstrcpy( (StringPtr) symName, name );
-#else
- strcpy( (char *)symName, name );
- c2pstr( (char *)symName );
-#endif
- if( FindSymbol( dllHandle, symName, &symAddress, &symClass ) == noErr )
- symbol = (void *)symAddress;
-
-#elif defined(__WXPM__) || defined(__EMX__)
- DosQueryProcAddr( m_handle, 1L, name.c_str(), (PFN*)symbol );
-
-#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
- symbol = dlsym( m_handle, name.c_str() );
-
-#elif defined(HAVE_SHL_LOAD)
- if( shl_findsym( &m_handle, name.c_str(), TYPE_UNDEFINED, &symbol ) != 0 )
- symbol = 0;
-
-#elif defined(__WINDOWS__)
- symbol = (void*) ::GetProcAddress( m_handle, name.mb_str() );
+ const wxClassInfo* const oldFirst = wxClassInfo::GetFirst();
+ Load( libname, flags );
-#else
-#error "runtime shared lib support not implemented"
-#endif
+ // It is simple to know what is the first object in the linked list of
+ // wxClassInfo that we registered (it's also the last one chronologically),
+ // it's just the new head of the wxClassInfo list:
+ m_ourFirst = wxClassInfo::GetFirst();
- if ( !symbol )
+ // But to find the first wxClassInfo created by this library we need to
+ // iterate until we get to the previous head as we don't have the links in
+ // the backwards direction:
+ if ( m_ourFirst != oldFirst )
{
- wxString msg(_("wxDynamicLibrary failed to GetSymbol '%s'"));
-#if defined(HAVE_DLERROR) && !defined(__EMX__)
- const wxChar *err = dlerror();
- if( err )
+ for ( const wxClassInfo* info = m_ourFirst; ; info = info->GetNext() )
{
- failed = TRUE;
- wxLogError( msg, err );
+ if ( info->GetNext() == oldFirst )
+ {
+ m_ourLast = info;
+ break;
+ }
}
-#else
- failed = TRUE;
- wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
- name.c_str());
-#endif
}
- if( success )
- *success = !failed;
-
- return symbol;
-}
-
-
-// ---------------------------------------------------------------------------
-// wxPluginLibrary
-// ---------------------------------------------------------------------------
-
-
-wxDLImports wxPluginLibrary::ms_classes(wxKEY_STRING);
-
-wxPluginLibrary::wxPluginLibrary(const wxString &libname, int flags)
- : m_linkcount(1)
- , m_objcount(0)
-{
- m_before = wxClassInfo::sm_first;
- Load( libname, flags );
- m_after = wxClassInfo::sm_first;
+ else // We didn't register any classes at all.
+ {
+ m_ourFirst =
+ m_ourLast = NULL;
+ }
if( m_handle != 0 )
{
- UpdateClassInfo();
+ UpdateClasses();
RegisterModules();
}
else
- --m_linkcount; // Flag us for deletion
+ {
+ // Flag us for deletion
+ --m_linkcount;
+ }
}
wxPluginLibrary::~wxPluginLibrary()
if( m_handle != 0 )
{
UnregisterModules();
- RestoreClassInfo();
+ RestoreClasses();
}
}
+wxPluginLibrary *wxPluginLibrary::RefLib()
+{
+ wxCHECK_MSG( m_linkcount > 0, NULL,
+ wxT("Library had been already deleted!") );
+
+ ++m_linkcount;
+ return this;
+}
+
bool wxPluginLibrary::UnrefLib()
{
- wxASSERT_MSG( m_objcount == 0, _T("Library unloaded before all objects were destroyed") );
- if( m_linkcount == 0 || --m_linkcount == 0 )
+ wxASSERT_MSG( m_objcount == 0,
+ wxT("Library unloaded before all objects were destroyed") );
+
+ if ( m_linkcount == 0 || --m_linkcount == 0 )
{
delete this;
- return TRUE;
+ return true;
}
- return FALSE;
+
+ return false;
}
// ------------------------
// Private methods
// ------------------------
-void wxPluginLibrary::UpdateClassInfo()
+void wxPluginLibrary::UpdateClasses()
{
- wxClassInfo *info;
- wxHashTable *t = wxClassInfo::sm_classTable;
-
- // FIXME: Below is simply a cut and paste specialisation of
- // wxClassInfo::InitializeClasses. Once this stabilises,
- // the two should probably be merged.
- //
- // Actually it's becoming questionable whether we should merge
- // this info with the main ClassInfo tables since we can nearly
- // handle this completely internally now and it does expose
- // certain (minimal % user_stupidy) risks.
-
- for(info = m_after; info != m_before; info = info->m_next)
+ if ( !m_ourFirst )
+ return;
+
+ for ( const wxClassInfo *info = m_ourFirst; ; info = info->GetNext() )
{
- if( info->m_className )
+ if( info->GetClassName() )
{
- if( t->Get(info->m_className) == 0 )
- t->Put(info->m_className, (wxObject *)info);
-
// Hash all the class names into a local table too so
// we can quickly find the entry they correspond to.
-
- if( ms_classes.Get(info->m_className) == 0 )
- ms_classes.Put(info->m_className, (wxObject *) this);
+ (*ms_classes)[info->GetClassName()] = this;
}
- }
- for(info = m_after; info != m_before; info = info->m_next)
- {
- if( info->m_baseClassName1 )
- info->m_baseInfo1 = (wxClassInfo *)t->Get(info->m_baseClassName1);
- if( info->m_baseClassName2 )
- info->m_baseInfo2 = (wxClassInfo *)t->Get(info->m_baseClassName2);
+ if ( info == m_ourLast )
+ break;
}
}
-void wxPluginLibrary::RestoreClassInfo()
+void wxPluginLibrary::RestoreClasses()
{
- wxClassInfo *info;
+ // Check if there is a need to restore classes.
+ if (!ms_classes)
+ return;
- for(info = m_after; info != m_before; info = info->m_next)
- {
- wxClassInfo::sm_classTable->Delete(info->m_className);
- ms_classes.Delete(info->m_className);
- }
+ if ( !m_ourFirst )
+ return;
- if( wxClassInfo::sm_first == m_after )
- wxClassInfo::sm_first = m_before;
- else
+ for ( const wxClassInfo *info = m_ourFirst; ; info = info->GetNext() )
{
- info = wxClassInfo::sm_first;
- while( info->m_next && info->m_next != m_after ) info = info->m_next;
+ ms_classes->erase(ms_classes->find(info->GetClassName()));
- wxASSERT_MSG( info, _T("ClassInfo from wxPluginLibrary not found on purge"))
-
- info->m_next = m_before;
+ if ( info == m_ourLast )
+ break;
}
}
// though, as there is currently no way to Unregister it without it.
wxASSERT_MSG( m_linkcount == 1,
- _T("RegisterModules should only be called for the first load") );
+ wxT("RegisterModules should only be called for the first load") );
- for(wxClassInfo *info = m_after; info != m_before; info = info->m_next)
+ if ( m_ourFirst )
{
- if( info->IsKindOf(CLASSINFO(wxModule)) )
+ for ( const wxClassInfo *info = m_ourFirst; ; info = info->GetNext() )
{
- wxModule *m = wxDynamicCast(info->CreateObject(), wxModule);
+ if( info->IsKindOf(wxCLASSINFO(wxModule)) )
+ {
+ wxModule *m = wxDynamicCast(info->CreateObject(), wxModule);
- wxASSERT_MSG( m, _T("wxDynamicCast of wxModule failed") );
+ wxASSERT_MSG( m, wxT("wxDynamicCast of wxModule failed") );
- m_wxmodules.Append(m);
- wxModule::RegisterModule(m);
+ m_wxmodules.push_back(m);
+ wxModule::RegisterModule(m);
+ }
+
+ if ( info == m_ourLast )
+ break;
}
}
// FIXME: Likewise this is (well was) very similar to InitializeModules()
- for(wxModuleList::Node *node = m_wxmodules.GetFirst(); node; node->GetNext())
+ for ( wxModuleList::iterator it = m_wxmodules.begin();
+ it != m_wxmodules.end();
+ ++it)
{
- if( !node->GetData()->Init() )
+ if( !(*it)->Init() )
{
- wxLogDebug(_T("wxModule::Init() failed for wxPluginLibrary"));
+ wxLogDebug(wxT("wxModule::Init() failed for wxPluginLibrary"));
// XXX: Watch this, a different hash implementation might break it,
// a good hash implementation would let us fix it though.
// let the dtor Exit the rest on shutdown, (which we'll initiate
// shortly).
- wxModuleList::Node *oldNode = 0;
+ wxModuleList::iterator oldNode = m_wxmodules.end();
do {
- node = node->GetNext();
- delete oldNode;
- wxModule::UnregisterModule( node->GetData() );
- oldNode = node;
- } while( node );
+ ++it;
+ if( oldNode != m_wxmodules.end() )
+ m_wxmodules.erase(oldNode);
+ wxModule::UnregisterModule( *it );
+ oldNode = it;
+ } while( it != m_wxmodules.end() );
--m_linkcount; // Flag us for deletion
break;
void wxPluginLibrary::UnregisterModules()
{
- wxModuleList::Node *node;
+ wxModuleList::iterator it;
- for(node = m_wxmodules.GetFirst(); node; node->GetNext())
- node->GetData()->Exit();
+ for ( it = m_wxmodules.begin(); it != m_wxmodules.end(); ++it )
+ (*it)->Exit();
- for(node = m_wxmodules.GetFirst(); node; node->GetNext())
- wxModule::UnregisterModule( node->GetData() );
+ for ( it = m_wxmodules.begin(); it != m_wxmodules.end(); ++it )
+ wxModule::UnregisterModule( *it );
- m_wxmodules.DeleteContents(TRUE);
+ // NB: content of the list was deleted by UnregisterModule calls above:
+ m_wxmodules.clear();
}
// ---------------------------------------------------------------------------
-// wxPluginLibrary
+// wxPluginManager
// ---------------------------------------------------------------------------
-wxDLManifest wxPluginManager::ms_manifest(wxKEY_STRING);
+wxDLManifest* wxPluginManager::ms_manifest = NULL;
// ------------------------
// Static accessors
// ------------------------
-wxPluginLibrary *wxPluginManager::LoadLibrary(const wxString &libname, int flags)
+wxPluginLibrary *
+wxPluginManager::LoadLibrary(const wxString &libname, int flags)
{
wxString realname(libname);
if( !(flags & wxDL_VERBATIM) )
- realname += wxDynamicLibrary::GetDllExt();
+ realname += wxDynamicLibrary::GetDllExt(wxDL_MODULE);
- wxPluginLibrary *entry = (wxPluginLibrary*) ms_manifest.Get(realname);
+ wxPluginLibrary *entry;
- if( entry != 0 )
+ if ( flags & wxDL_NOSHARE )
{
+ entry = NULL;
+ }
+ else
+ {
+ entry = FindByName(realname);
+ }
+
+ if ( entry )
+ {
+ wxLogTrace(wxT("dll"),
+ wxT("LoadLibrary(%s): already loaded."), realname.c_str());
+
entry->RefLib();
}
else
{
entry = new wxPluginLibrary( libname, flags );
- if( entry->IsLoaded() )
+ if ( entry->IsLoaded() )
{
- ms_manifest.Put(realname, (wxObject*) entry);
+ (*ms_manifest)[realname] = entry;
+
+ wxLogTrace(wxT("dll"),
+ wxT("LoadLibrary(%s): loaded ok."), realname.c_str());
+
}
else
{
- wxCHECK_MSG( entry->UnrefLib(), 0,
- _T("Currently linked library is, ..not loaded??") );
- entry = 0;
+ wxLogTrace(wxT("dll"),
+ wxT("LoadLibrary(%s): failed to load."), realname.c_str());
+
+ // we have created entry just above
+ if ( !entry->UnrefLib() )
+ {
+ // ... so UnrefLib() is supposed to delete it
+ wxFAIL_MSG( wxT("Currently linked library is not loaded?") );
+ }
+
+ entry = NULL;
}
}
+
return entry;
}
-bool wxPluginManager::UnloadLibrary(const wxString &libname)
+bool wxPluginManager::UnloadLibrary(const wxString& libname)
{
- wxPluginLibrary *entry = (wxPluginLibrary*) ms_manifest.Get(libname);
+ wxString realname = libname;
- if( !entry )
- entry = (wxPluginLibrary*) ms_manifest.Get(libname + wxDynamicLibrary::GetDllExt());
+ wxPluginLibrary *entry = FindByName(realname);
- if( entry )
- return entry->UnrefLib();
+ if ( !entry )
+ {
+ realname += wxDynamicLibrary::GetDllExt(wxDL_MODULE);
- wxLogDebug(_T("Attempt to Unlink library '%s' (which is not linked)."), libname.c_str());
- return FALSE;
-}
+ entry = FindByName(realname);
+ }
-#if WXWIN_COMPATIBILITY_2_2
-wxPluginLibrary *wxPluginManager::GetObjectFromHandle(wxDllType handle)
-{
- wxNode *node;
- ms_manifest.BeginFind();
+ if ( !entry )
+ {
+ wxLogDebug(wxT("Attempt to unload library '%s' which is not loaded."),
+ libname.c_str());
+
+ return false;
+ }
- for(node = ms_manifest.Next(); node; node = ms_manifest.Next())
- if( ((wxPluginLibrary*)node->GetData())->GetLibHandle() == handle )
- return (wxPluginLibrary*)node->GetData();
+ wxLogTrace(wxT("dll"), wxT("UnloadLibrary(%s)"), realname.c_str());
- return 0;
+ if ( !entry->UnrefLib() )
+ {
+ // not really unloaded yet
+ return false;
+ }
+
+ ms_manifest->erase(ms_manifest->find(realname));
+
+ return true;
}
-#endif
// ------------------------
// Class implementation
bool wxPluginManager::Load(const wxString &libname, int flags)
{
m_entry = wxPluginManager::LoadLibrary(libname, flags);
+
return IsLoaded();
}
void wxPluginManager::Unload()
{
- wxNode *node;
- ms_manifest.BeginFind();
-
- // It's either this or store the name of the lib just to do this.
-
- for(node = ms_manifest.Next(); node; node = ms_manifest.Next())
- if( (wxPluginLibrary*)node->GetData() == m_entry )
- break;
+ wxCHECK_RET( m_entry, wxT("unloading an invalid wxPluginManager?") );
- if( m_entry && m_entry->UnrefLib() )
+ for ( wxDLManifest::iterator i = ms_manifest->begin();
+ i != ms_manifest->end();
+ ++i )
{
- delete node;
- m_entry = 0;
+ if ( i->second == m_entry )
+ {
+ ms_manifest->erase(i);
+ break;
+ }
}
-}
-// ---------------------------------------------------------------------------
-// wxDllLoader (all these methods are static)
-// ---------------------------------------------------------------------------
+ m_entry->UnrefLib();
-#if WXWIN_COMPATIBILITY_2_2
-
-wxDllType wxDllLoader::LoadLibrary(const wxString &name)
-{
- wxPluginLibrary *p = wxPluginManager::LoadLibrary(name, wxDL_DEFAULT | wxDL_VERBATIM);
- return p->GetLibHandle();
+ m_entry = NULL;
}
-void wxDllLoader::UnloadLibrary(wxDllType handle)
-{
- wxPluginLibrary *p = wxPluginManager::GetObjectFromHandle(handle);
- p->UnrefLib();
-}
-
-void *wxDllLoader::GetSymbol(wxDllType dllHandle, const wxString &name, bool *success)
-{
- wxPluginLibrary *p = wxPluginManager::GetObjectFromHandle(dllHandle);
- return p->GetSymbol(name, success);
-}
-
-#endif // WXWIN_COMPATIBILITY_2_2
-
#endif // wxUSE_DYNAMIC_LOADER
-
-// vi:sts=4:sw=4:et
projects / wxWidgets.git / blobdiff