]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/dynload.cpp
fixing osx_carbon
[wxWidgets.git] / src / common / dynload.cpp
index fad9d7515a7a50f206bd2dd57800c36378ab9ad7..a76a1907334f1b9e80f6586ee1d6932271deea68 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// 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)
 // Licence:      wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "dynload.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
     #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"
-#include "wx/module.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
-// ---------------------------------------------------------------------------
-
-//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 wxChar *wxDynamicLibrary::ms_dllext = _T(".dll");
-#elif defined(__UNIX__)
-    #if defined(__HPUX__)
-        const wxChar *wxDynamicLibrary::ms_dllext = _T(".sl");
-    #else
-        const wxChar *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
-}
-
-bool wxDynamicLibrary::Load(wxString libname, int flags)
-{
-    wxASSERT_MSG(m_handle == 0, _T("Library already loaded."));
-
-    // add the proper extension for the DLL ourselves unless told not to
-    if ( !(flags & wxDL_VERBATIM) )
-    {
-        // and also check that the libname doesn't already have it
-        wxString ext;
-        wxFileName::SplitPath(libname, NULL, NULL, &ext);
-        if ( ext.empty() )
-        {
-            libname += GetDllExt();
-        }
-    }
-
-    // different ways to load a shared library
-    //
-    // FIXME: should go to the platform-specific files!
-#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 )
-    {
-        p2cstr( myErrName );
-        wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
-                       libname.c_str(),
-                       (char*)myErrName );
-        m_handle = 0;
-    }
-
-#elif defined(__WXPM__) || defined(__EMX__)
-    char    err[256] = "";
-    DosLoadModule(err, sizeof(err), libname.c_str(), &m_handle);
-
-#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
-
-#if defined(__VMS) || defined(__DARWIN__)
-    m_handle = dlopen(libname.c_str(), 0);  // The second parameter is ignored
-#else // !__VMS  && !__DARWIN__
-    int rtldFlags = 0;
-
-    if ( flags & wxDL_LAZY )
-    {
-        wxASSERT_MSG( (flags & wxDL_NOW) == 0,
-                      _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") );
-#ifdef RTLD_LAZY
-        rtldFlags |= RTLD_LAZY;
-#else
-        wxLogDebug(_T("wxDL_LAZY is not supported on this platform"));
-#endif
-    }
-    else if ( flags & wxDL_NOW )
-    {
-#ifdef RTLD_NOW
-        rtldFlags |= RTLD_NOW;
-#else
-        wxLogDebug(_T("wxDL_NOW is not supported on this platform"));
-#endif
-    }
-
-    if ( flags & wxDL_GLOBAL )
-    {
-#ifdef RTLD_GLOBAL
-        rtldFlags |= RTLD_GLOBAL;
-#else
-        wxLogDebug(_T("RTLD_GLOBAL is not supported on this platform."));
-#endif
-    }
-
-    m_handle = dlopen(libname.fn_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.fn_str(), BIND_DEFERRED, 0);
-
-#elif defined(__WINDOWS__)
-    m_handle = ::LoadLibrary(libname.c_str());
-#else
-    #error  "runtime shared lib support not implemented on this platform"
-#endif
-
-    if ( m_handle == 0 )
-    {
-        wxString msg(_("Failed to load shared library '%s'"));
-#if defined(HAVE_DLERROR) && !defined(__EMX__)
-
-#if wxUSE_UNICODE
-        wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() );
-        const wxChar *err = buffer;
-#else
-        const wxChar *err = dlerror();
-#endif
-
-        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
-{
-    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.fn_str() );
-
-#elif defined(HAVE_SHL_LOAD)
-    // use local variable since shl_findsym modifies the handle argument
-    // to indicate where the symbol was found (GD)
-    wxDllType the_handle = m_handle;
-    if( shl_findsym( &the_handle, name.fn_str(), TYPE_UNDEFINED, &symbol ) != 0 )
-        symbol = 0;
-
-#elif defined(__WINDOWS__)
-    symbol = (void*) ::GetProcAddress( m_handle, name.mb_str() );
-
-#else
-#error  "runtime shared lib support not implemented"
-#endif
-
-    if ( !symbol )
-    {
-#if defined(HAVE_DLERROR) && !defined(__EMX__)
-
-#if wxUSE_UNICODE
-        wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() );
-        const wxChar *err = buffer;
-#else
-        const wxChar *err = dlerror();
-#endif
-
-        if( err )
-        {
-            wxLogError(wxT("%s"), err);
-        }
-#else
-        failed = TRUE;
-        wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
-                      name.c_str());
-#endif
-    }
-    if( success )
-        *success = !failed;
-
-    return symbol;
-}
-    
-
-/*static*/
-wxString wxDynamicLibrary::CanonicalizeName(const wxString& name,
-                                            wxDynamicLibraryCategory cat)
-{
-#ifdef __UNIX__
-    if ( cat == wxDL_MODULE )
-        return name + GetDllExt();
-    else
-        return wxString(_T("lib")) + name + GetDllExt();
-#else
-    return name + GetDllExt();
-#endif
-}
-
-/*static*/
-wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
-                                                  wxPluginCategory cat)
-{
-    wxString suffix;
-    if ( cat == wxDL_PLUGIN_GUI )
-    {
-        suffix = wxString::FromAscii(
-#if defined(__WXMSW__)
-                "msw"
-#elif defined(__WXGTK__)
-                "gtk"
-#elif defined(__WXMGL__)
-                "mgl"
-#elif defined(__WXMOTIF__)
-                "motif"
-#elif defined(__WXOS2__)
-                "pm"
-#elif defined(__WXX11__)
-                "x11"
-#elif defined(__WXMAC__)
-                "mac"
-#elif defined(__WXCOCOA__)
-                "cocoa"
-#endif
-       );
-
-#ifdef __WXUNIVERSAL__
-        suffix << _T("univ");
-#endif
-    }
-#if wxUSE_UNICODE
-    suffix << _T('u');
-#endif
-#ifdef __WXDEBUG__
-    suffix << _T('d');
-#endif
-
-    if ( !suffix.empty() )
-        suffix = wxString(_T("_")) + suffix;
-
-#ifdef __UNIX__
-    #if (wxMINOR_VERSION % 2) == 0
-        #define wxDLLVER(x,y,z) "-" #x "." #y
-    #else
-        #define wxDLLVER(x,y,z) "-" #x "." #y "." #z
-    #endif
-#else
-    #if (wxMINOR_VERSION % 2) == 0
-        #define wxDLLVER(x,y,z) #x #y
-    #else
-        #define wxDLLVER(x,y,z) #x #y #z
-    #endif
-#endif
-    suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
-                                           wxRELEASE_NUMBER));
-#undef wxDLLVER
-
-    return CanonicalizeName(name + suffix, wxDL_MODULE);
-}
-    
-/*static*/
-wxString wxDynamicLibrary::GetPluginsDirectory()
-{
-#ifdef __UNIX__
-    wxString format = wxGetInstallPrefix();
-    format << wxFILE_SEP_PATH
-           << wxT("lib") << wxFILE_SEP_PATH
-           << wxT("wx") << wxFILE_SEP_PATH
-           << wxT("%i.%i");
-    wxString dir;
-    dir.Printf(format.c_str(), wxMAJOR_VERSION, wxMINOR_VERSION);
-    return dir;
-#else
-    return wxEmptyString;
-#endif
-}
 
 
 // ---------------------------------------------------------------------------
@@ -414,15 +54,14 @@ public:
     // TODO: create ms_classes on demand, why always preallocate it?
     virtual bool OnInit()
     {
-        wxPluginLibrary::ms_classes = new wxDLImports(wxKEY_STRING);
+        wxPluginLibrary::ms_classes = new wxDLImports;
         wxPluginManager::CreateManifest();
-        return TRUE;
+        return true;
     }
 
     virtual void OnExit()
     {
-        delete wxPluginLibrary::ms_classes;
-        wxPluginLibrary::ms_classes = NULL;
+        wxDELETE(wxPluginLibrary::ms_classes);
         wxPluginManager::ClearManifest();
     }
 
@@ -437,13 +76,13 @@ wxPluginLibrary::wxPluginLibrary(const wxString &libname, int flags)
         : m_linkcount(1)
         , m_objcount(0)
 {
-    m_before = wxClassInfo::sm_first;
+    m_before = wxClassInfo::GetFirst();
     Load( libname, flags );
-    m_after = wxClassInfo::sm_first;
+    m_after = wxClassInfo::GetFirst();
 
     if( m_handle != 0 )
     {
-        UpdateClassInfo();
+        UpdateClasses();
         RegisterModules();
     }
     else
@@ -458,14 +97,14 @@ wxPluginLibrary::~wxPluginLibrary()
     if( m_handle != 0 )
     {
         UnregisterModules();
-        RestoreClassInfo();
+        RestoreClasses();
     }
 }
 
 wxPluginLibrary *wxPluginLibrary::RefLib()
 {
     wxCHECK_MSG( m_linkcount > 0, NULL,
-                 _T("Library had been already deleted!") );
+                 wxT("Library had been already deleted!") );
 
     ++m_linkcount;
     return this;
@@ -474,79 +113,43 @@ wxPluginLibrary *wxPluginLibrary::RefLib()
 bool wxPluginLibrary::UnrefLib()
 {
     wxASSERT_MSG( m_objcount == 0,
-                  _T("Library unloaded before all objects were destroyed") );
+                  wxT("Library unloaded before all objects were destroyed") );
 
-    if ( --m_linkcount == 0 )
+    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)
+    for (const wxClassInfo *info = m_after; info != m_before; 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.
-            (*ms_classes)[info->m_className] = this;
+            (*ms_classes)[info->GetClassName()] = this;
         }
     }
-
-#if wxUSE_EXTENDED_RTTI == 0
-    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);
-    }
-#endif
 }
 
-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->erase(ms_classes->find(info->m_className));
-    }
-
-    if( wxClassInfo::sm_first == m_after )
-        wxClassInfo::sm_first = m_before;
-    else
+    for(const wxClassInfo *info = m_after; info != m_before; info = info->GetNext())
     {
-        info = wxClassInfo::sm_first;
-        while( info->m_next && info->m_next != m_after ) info = info->m_next;
-
-        wxASSERT_MSG( info, _T("ClassInfo from wxPluginLibrary not found on purge"));
-
-        info->m_next = m_before;
+        ms_classes->erase(ms_classes->find(info->GetClassName()));
     }
 }
 
@@ -561,15 +164,15 @@ void wxPluginLibrary::RegisterModules()
     // 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)
+    for ( const wxClassInfo *info = m_after; info != m_before; info = info->GetNext())
     {
         if( info->IsKindOf(CLASSINFO(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.push_back(m);
             wxModule::RegisterModule(m);
@@ -584,7 +187,7 @@ void wxPluginLibrary::RegisterModules()
     {
         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.
@@ -618,7 +221,8 @@ void wxPluginLibrary::UnregisterModules()
     for ( it = m_wxmodules.begin(); it != m_wxmodules.end(); ++it )
         wxModule::UnregisterModule( *it );
 
-    WX_CLEAR_LIST(wxModuleList, m_wxmodules);
+    // NB: content of the list was deleted by UnregisterModule calls above:
+    m_wxmodules.clear();
 }
 
 
@@ -653,8 +257,8 @@ wxPluginManager::LoadLibrary(const wxString &libname, int flags)
 
     if ( entry )
     {
-        wxLogTrace(_T("dll"),
-                   _T("LoadLibrary(%s): already loaded."), realname.c_str());
+        wxLogTrace(wxT("dll"),
+                   wxT("LoadLibrary(%s): already loaded."), realname.c_str());
 
         entry->RefLib();
     }
@@ -666,20 +270,20 @@ wxPluginManager::LoadLibrary(const wxString &libname, int flags)
         {
             (*ms_manifest)[realname] = entry;
 
-            wxLogTrace(_T("dll"),
-                       _T("LoadLibrary(%s): loaded ok."), realname.c_str());
+            wxLogTrace(wxT("dll"),
+                       wxT("LoadLibrary(%s): loaded ok."), realname.c_str());
 
         }
         else
         {
-            wxLogTrace(_T("dll"),
-                       _T("LoadLibrary(%s): failed to load."), realname.c_str());
+            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( _T("Currently linked library is not loaded?") );
+                wxFAIL_MSG( wxT("Currently linked library is not loaded?") );
             }
 
             entry = NULL;
@@ -704,42 +308,25 @@ bool wxPluginManager::UnloadLibrary(const wxString& libname)
 
     if ( !entry )
     {
-        wxLogDebug(_T("Attempt to unload library '%s' which is not loaded."),
+        wxLogDebug(wxT("Attempt to unload library '%s' which is not loaded."),
                    libname.c_str());
 
-        return FALSE;
+        return false;
     }
 
-    wxLogTrace(_T("dll"), _T("UnloadLibrary(%s)"), realname.c_str());
+    wxLogTrace(wxT("dll"), wxT("UnloadLibrary(%s)"), realname.c_str());
 
     if ( !entry->UnrefLib() )
     {
         // not really unloaded yet
-        return FALSE;
+        return false;
     }
 
     ms_manifest->erase(ms_manifest->find(realname));
 
-    return TRUE;
+    return true;
 }
 
-#if WXWIN_COMPATIBILITY_2_2
-wxPluginLibrary *wxPluginManager::GetObjectFromHandle(wxDllType handle)
-{
-    for ( wxDLManifest::iterator i = ms_manifest->begin();
-          i != ms_manifest->end();
-          ++i )
-    {
-        wxPluginLibrary * const lib = i->second;
-
-        if ( lib->GetLibHandle() == handle )
-            return lib;
-    }
-
-    return NULL;
-}
-#endif // WXWIN_COMPATIBILITY_2_2
-
 // ------------------------
 // Class implementation
 // ------------------------
@@ -753,7 +340,7 @@ bool wxPluginManager::Load(const wxString &libname, int flags)
 
 void wxPluginManager::Unload()
 {
-    wxCHECK_RET( m_entry, _T("unloading an invalid wxPluginManager?") );
+    wxCHECK_RET( m_entry, wxT("unloading an invalid wxPluginManager?") );
 
     for ( wxDLManifest::iterator i = ms_manifest->begin();
           i != ms_manifest->end();
@@ -771,54 +358,4 @@ void wxPluginManager::Unload()
     m_entry = NULL;
 }
 
-// ---------------------------------------------------------------------------
-// wxDllLoader   (all these methods are static)
-// ---------------------------------------------------------------------------
-
-#if WXWIN_COMPATIBILITY_2_2
-
-wxDllType wxDllLoader::LoadLibrary(const wxString &name, bool *success)
-{
-    wxPluginLibrary *p = wxPluginManager::LoadLibrary
-                         (
-                            name,
-                            wxDL_DEFAULT | wxDL_VERBATIM | wxDL_NOSHARE
-                         );
-
-    if ( success )
-        *success = p != NULL;
-
-    return p ? p->GetLibHandle() : 0;
-}
-
-void wxDllLoader::UnloadLibrary(wxDllType handle)
-{
-    wxPluginLibrary *p = wxPluginManager::GetObjectFromHandle(handle);
-
-    wxCHECK_RET( p, _T("Unloading a library not loaded with wxDllLoader?") );
-
-    p->UnrefLib();
-}
-
-void *
-wxDllLoader::GetSymbol(wxDllType dllHandle, const wxString &name, bool *success)
-{
-    wxPluginLibrary *p = wxPluginManager::GetObjectFromHandle(dllHandle);
-
-    if ( !p )
-    {
-        wxFAIL_MSG( _T("Using a library not loaded with wxDllLoader?") );
-
-        if ( success )
-            *success = FALSE;
-
-        return NULL;
-    }
-
-    return p->GetSymbol(name, success);
-}
-
-#endif  // WXWIN_COMPATIBILITY_2_2
-
 #endif  // wxUSE_DYNAMIC_LOADER
-