Coupled some core functionality out, to allow its use outside the wxLibrary

framework. Fixed a Unix bug (I believe). Untested, sorry for that, will test
ASAP.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@2700 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/include/wx/dynlib.h b/include/wx/dynlib.h
index 98bc1839a60e1c62607d3cedc4d4f1a8644f914a..ec1b270bd320486bb00f519cf8e53061ff0e145e 100644 (file)
--- a/include/wx/dynlib.h
+++ b/include/wx/dynlib.h
@@ -13,7 +13,7 @@
 #define _WX_DYNLIB_H__
 
 #ifdef __GNUG__
-    #pragma interface
+#   pragma interface
 #endif
 
 #include <wx/setup.h>
@@ -26,36 +26,65 @@
 
 // this is normally done by configure, but I leave it here for now...
 #if defined(__UNIX__) && !(defined(HAVE_DLOPEN) || defined(HAVE_SHL_LOAD))
-    #if defined(__LINUX__) || defined(__SOLARIS__) || defined(__SUNOS__) || defined(__FREEBSD__)
-        #define HAVE_DLOPEN
-    #elif defined(__HPUX__)
-        #define HAVE_SHL_LOAD
-    #endif // Unix flavour
+#   if defined(__LINUX__) || defined(__SOLARIS__) || defined(__SUNOS__) || defined(__FREEBSD__)
+#      define HAVE_DLOPEN
+#   elif defined(__HPUX__)
+#      define HAVE_SHL_LOAD
+#   endif // Unix flavour
 #endif // !Unix or already have some HAVE_xxx defined
 
 #if defined(HAVE_DLOPEN)
-    #include <dlfcn.h>
-
+#   include <dlfcn.h>
     typedef void *wxDllType;
 #elif defined(HAVE_SHL_LOAD)
-    #include <dl.h>
-
+#   include <dl.h>
     typedef shl_t wxDllType;
 #elif defined(__WINDOWS__)
-    #include <windows.h>
-
+#   include <windows.h>
     typedef HMODULE wxDllType;
 #elif defined(__WXMAC__)
     typedef CFragConnectionID wxDllType;
 #else
-    #error "wxLibrary can't be compiled on this platform, sorry."
+#   error "wxLibrary can't be compiled on this platform, sorry."
 #endif // OS
 
 // defined in windows.h
 #ifdef LoadLibrary
-    #undef LoadLibrary
+#   undef LoadLibrary
 #endif
 
+// ----------------------------------------------------------------------------
+// wxDllLoader
+// ----------------------------------------------------------------------------
+/** wxDllLoader is a class providing an interface similar to unix's
+    dlopen(). It is used by the wxLibrary framework and manages the
+    actual loading of DLLs and the resolving of symbols in them.
+    There are no instances of this class, it simply serves as a
+    namespace for its static member functions.
+*/
+class wxDllLoader
+{
+ public:
+   /** This function loads a shared library into memory, with libname
+       being the basename of the library, without the filename
+       extension. No initialisation of the library will be done.
+       @param libname Name of the shared object to load.
+       @param success Must point to a bool variable which will be set to TRUE or FALSE.
+       @return A handle to the loaded DLL. Use success parameter to test if it is valid.
+   */
+   static wxDllType LoadDll(const wxString & libname, bool *success);
+   /** This function resolves a symbol in a loaded DLL, such as a
+       variable or function name.
+       @param dllHandle Handle of the DLL, as returned by LoadDll().
+       @param name Name of the symbol.
+       @return A pointer to the symbol.
+   */
+   static void * GetSymbol(wxDllType dllHandle, const wxString &name);
+ private:
+   /// forbid construction of objects
+   wxDllLoader() 
+};
+
 // ----------------------------------------------------------------------------
 // wxLibrary
 // ----------------------------------------------------------------------------
@@ -81,6 +110,8 @@ protected:
     wxDllType m_handle;
 };
 
+
+
 // ----------------------------------------------------------------------------
 // wxLibraries
 // ----------------------------------------------------------------------------

diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp
index b4a60768fb10eb2357b00c048ecfbae07d6bf25b..1e0fc6bdf449d42be7b2db2e6e7844aae99936ca 100644 (file)
--- a/src/common/dynlib.cpp
+++ b/src/common/dynlib.cpp
@@ -18,13 +18,13 @@
 // ----------------------------------------------------------------------------
 
 #ifdef __GNUG__
-    #pragma implementation "dynlib.h"
+#   pragma implementation "dynlib.h"
 #endif
 
 #include  "wx/wxprec.h"
 
 #ifdef    __BORLANDC__
-  #pragma hdrstop
+#   pragma hdrstop
 #endif  //__BORLANDC__
 
 #if wxUSE_DYNLIB_CLASS
@@ -40,12 +40,12 @@
 // ----------------------------------------------------------------------------
 
 #if defined(HAVE_DLOPEN)
-    #define wxDllOpen(lib)                dlopen(lib.fn_str(), RTLD_LAZY)
-    #define wxDllGetSymbol(handle, name)  dlsym(handle, name.mb_str())
-    #define wxDllClose                    dlclose
+#   define wxDllOpen(lib)                dlopen(lib.fn_str(), RTLD_LAZY)
+#   define wxDllGetSymbol(handle, name)  dlsym(handle, name.mb_str())
+#   define wxDllClose                    dlclose
 #elif defined(HAVE_SHL_LOAD)
-    #define wxDllOpen(lib)                shl_load(lib.fn_str(), BIND_DEFERRED, 0)
-    #define wxDllClose      shl_unload
+#   define wxDllOpen(lib)                shl_load(lib.fn_str(), BIND_DEFERRED, 0)
+#   define wxDllClose      shl_unload
 
     static inline void *wxDllGetSymbol(shl_t handle, const wxString& name)
     {
@@ -56,18 +56,18 @@
             return (void *)0;
     }
 #elif defined(__WINDOWS__)
-    #include <windows.h>
+#   include <windows.h>
 
     // using LoadLibraryEx under Win32 to avoid name clash with LoadLibrary
-    #ifdef __WIN32__
-        #define wxDllOpen(lib)                  ::LoadLibraryEx(lib, 0, 0)
-    #else   // Win16
-        #define wxDllOpen(lib)                  ::LoadLibrary(lib)
-    #endif  // Win32/16
-    #define wxDllGetSymbol(handle, name)    ::GetProcAddress(handle, name)
-    #define wxDllClose                      ::FreeLibrary
+#   ifdef __WIN32__
+#      define wxDllOpen(lib)                  ::LoadLibraryEx(lib, 0, 0)
+#   else   // Win16
+#      define wxDllOpen(lib)                  ::LoadLibrary(lib)
+#   endif  // Win32/16
+#   define wxDllGetSymbol(handle, name)    ::GetProcAddress(handle, name)
+#   define wxDllClose                      ::FreeLibrary
 #else
-    #error "Don't know how to load shared libraries on this platform."
+#   error "Don't know how to load shared libraries on this platform."
 #endif // OS
 
 // ---------------------------------------------------------------------------
@@ -87,11 +87,11 @@ static wxString ConstructLibraryName(const wxString& basename)
     wxString fullname(basename);
 
 #if defined(__UNIX__)
-    #if defined(__HPUX__)
+#   if defined(__HPUX__)
         fullname << ".sl";
-    #else      //__HPUX__
+#   else       //__HPUX__
         fullname << ".so";
-    #endif     //__HPUX__
+#   endif      //__HPUX__
 #elif defined(__WINDOWS__)
     fullname << ".dll";
 #endif
@@ -103,6 +103,7 @@ static wxString ConstructLibraryName(const wxString& basename)
 // implementation
 // ============================================================================
 
+
 // ---------------------------------------------------------------------------
 // wxLibrary (one instance per dynamic library)
 // ---------------------------------------------------------------------------
@@ -164,30 +165,74 @@ void wxLibrary::PrepareClasses(wxClassInfo *first)
 
 void *wxLibrary::GetSymbol(const wxString& symbname)
 {
-    void *symbol = NULL;    // return value
+   return wxDllLoader::GetSymbol(m_handle, symbname);
+}
 
-#if defined( __WXMAC__ )
-    Ptr symAddress ;
-    CFragSymbolClass symClass ;
-    Str255     symName ;
+// ---------------------------------------------------------------------------
+// wxDllLoader
+// ---------------------------------------------------------------------------
 
-    strcpy( (char*) symName , symbname ) ;
-    c2pstr( (char*) symName ) ;
+/* static */
+wxDllType
+wxDllLoader::LoadLibrary(const wxString & libname, bool *success)
+{
+   wxASSERT(success);
+   
+   wxDllType handle;
 
-    if ( FindSymbol( m_handle , symName , &symAddress , &symClass ) == noErr )
-    {
-        symbol = (void *)symAddress ; 
-    }
+#if defined(__WXMAC__)
+   FSSpec myFSSpec ;
+   Ptr myMainAddr ;
+   Str255      myErrName ;
+   
+   wxMacPathToFSSpec( lib_name , &myFSSpec ) ;
+   if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr ,
+                        myErrName ) != noErr )
+   {
+      p2cstr( myErrName ) ;
+      wxASSERT_MSG( 1 , (char*)myErrName ) ;
+      return NULL ;
+   }
+#else // !Mac
+   handle = wxDllOpen(lib_name);
+#endif // OS
+
+   if ( !handle )
+   {
+      wxLogSysError(_("Failed to load shared library '%s'"),
+                    lib_name.c_str());
+      *success = FALSE;
+      return NULL;
+   }
+   *success = TRUE;
+   return handle;
+}
+
+/* static */
+void *
+wxDllLoader::GetSymbol(wxDllType dllHandle, const wxString &name)
+{
+   void *symbol = NULL;    // return value
+
+#if defined( __WXMAC__ )
+   Ptr symAddress ;
+   CFragSymbolClass symClass ;
+   Str255      symName ;
+   
+   strcpy( (char*) symName , name ) ;
+   c2pstr( (char*) symName ) ;
+   
+   if ( FindSymbol( dllHandle , symName , &symAddress , &symClass ) == noErr )
+      symbol = (void *)symAddress ; 
 #else
-    symbol = wxDllGetSymbol(m_handle, symbname);
+    symbol = wxDllGetSymbol(dllHandle, name);
 #endif
 
     if ( !symbol )
     {
-        wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
-                      symbname.c_str());
+       wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
+                     symbname.c_str());
     }
-
     return symbol;
 }
 
@@ -226,6 +271,10 @@ wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
 
     wxString lib_name = ConstructLibraryName(name);
 
+/*
+  Unix automatically builds that library name, at least for dlopen()
+*/
+#if 0
 #if defined(__UNIX__)
     // found the first file in LD_LIBRARY_PATH with this name
     wxString libPath("/lib:/usr/lib"); // system path first
@@ -249,40 +298,18 @@ wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
     //else: not found in the path, leave the name as is (secutiry risk?)
 
 #endif // __UNIX__
+#endif
 
-    wxDllType handle;
-
-#if defined(__WXMAC__)
-    FSSpec myFSSpec ;
-    Ptr        myMainAddr ;
-    Str255     myErrName ;
-
-    wxMacPathToFSSpec( lib_name , &myFSSpec ) ;
-    if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr ,
-                myErrName ) != noErr )
-    {
-        p2cstr( myErrName ) ;
-        wxASSERT_MSG( 1 , (char*)myErrName ) ;
-        return NULL ;
-    }
-#else // !Mac
-    handle = wxDllOpen(lib_name);
-#endif // OS
-
-    if ( !handle )
+    bool success;
+    handle = wxDllLoader::LoadDll(lib_name, &success);
+    if(success)
     {
-        wxLogSysError(_("Failed to load shared library '%s'"),
-                      lib_name.c_str());
-
-        return NULL;
+       lib = new wxLibrary(handle);
+       wxClassInfo::sm_first = old_sm_first;
+       m_loaded.Append(name.GetData(), lib);
     }
-
-    lib = new wxLibrary(handle);
-
-    wxClassInfo::sm_first = old_sm_first;
-
-    m_loaded.Append(name.GetData(), lib);
-
+    else
+       lib = NULL;
     return lib;
 }