Committing in .

[wxWidgets.git] / src / common / dynlib.cpp

diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp
index b4a60768fb10eb2357b00c048ecfbae07d6bf25b..5c93399eee466932826be97f12f5e5d33360eb31 100644 (file)
--- a/src/common/dynlib.cpp
+++ b/src/common/dynlib.cpp
@@ -18,17 +18,21 @@
 // ----------------------------------------------------------------------------
 
 #ifdef __GNUG__
 // ----------------------------------------------------------------------------
 
 #ifdef __GNUG__

-    #pragma implementation "dynlib.h"
+#   pragma implementation "dynlib.h"

 #endif
 
 #include  "wx/wxprec.h"
 
 #endif
 
 #include  "wx/wxprec.h"
 

-#ifdef    __BORLANDC__
+#ifdef __BORLANDC__

   #pragma hdrstop
   #pragma hdrstop

-#endif  //__BORLANDC__
+#endif

 
 #if wxUSE_DYNLIB_CLASS
 
 
 #if wxUSE_DYNLIB_CLASS
 

+#if defined(__WINDOWS__)
+    #include "wx/msw/private.h"
+#endif
+

 #include "wx/dynlib.h"
 #include "wx/filefn.h"
 #include "wx/intl.h"
 #include "wx/dynlib.h"
 #include "wx/filefn.h"
 #include "wx/intl.h"


@@ -39,13 +43,30 @@
 // conditional compilation
 // ----------------------------------------------------------------------------
 
 // conditional compilation
 // ----------------------------------------------------------------------------
 

-#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
+#if defined(__WXPM__) || defined(__EMX__)
+#  define INCL_DOS
+#  include <os2.h>
+#  define wxDllOpen(error, lib, handle)     DosLoadModule(error, sizeof(error), lib, &handle)
+#  define wxDllGetSymbol(handle, modaddr)   DosQueryProcAddr(handle, 1L, NULL, (PFN*)modaddr)
+#  define wxDllClose(handle)                DosFreeModule(handle)
+#elif defined(HAVE_DLOPEN)
+    // note about dlopen() flags: we use RTLD_NOW to have more Windows-like
+    // behaviour (Win won't let you load a library with missing symbols) and
+    // RTLD_GLOBAL because it is needed sometimes and probably doesn't hurt
+    // otherwise. On True64-Unix RTLD_GLOBAL is not allowed and on VMS the
+    // second argument on dlopen is ignored.
+#ifdef __VMS
+# define wxDllOpen(lib)                dlopen(lib.fn_str(), 0 )
+#elif defined( __osf__ )
+# define wxDllOpen(lib)                dlopen(lib.fn_str(), RTLD_LAZY )
+#else
+# define wxDllOpen(lib)                dlopen(lib.fn_str(), RTLD_LAZY | RTLD_GLOBAL)
+#endif
+#define wxDllGetSymbol(handle, name)  dlsym(handle, name)
+#   define wxDllClose                    dlclose

 #elif defined(HAVE_SHL_LOAD)
 #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)
     {
 
     static inline void *wxDllGetSymbol(shl_t handle, const wxString& name)
     {


@@ -55,19 +76,32 @@
         else
             return (void *)0;
     }
         else
             return (void *)0;
     }

+#elif defined(__APPLE__) && defined(__UNIX__)
+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);
+
+#   define wxDllOpen(lib)                dlopen(lib.fn_str(), 0)
+#   define wxDllGetSymbol(handle, name)  dlsym(handle, name)
+#   define wxDllClose                    dlclose

 #elif defined(__WINDOWS__)
 #elif defined(__WINDOWS__)

-    #include <windows.h>
-

     // using LoadLibraryEx under Win32 to avoid name clash with LoadLibrary
     // 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__
+#ifdef _UNICODE
+#      define wxDllOpen(lib)                  ::LoadLibraryExW(lib, 0, 0)

 #else
 #else

-    #error "Don't know how to load shared libraries on this platform."
+#      define wxDllOpen(lib)                  ::LoadLibraryExA(lib, 0, 0)
+#endif
+#   else   // Win16
+#      define wxDllOpen(lib)                  ::LoadLibrary(lib)
+#   endif  // Win32/16
+#   define wxDllGetSymbol(handle, name)    ::GetProcAddress(handle, name)
+#   define wxDllClose                      ::FreeLibrary
+#elif defined(__WXMAC__)
+#   define wxDllClose(handle)               CloseConnection(&handle)
+#else
+#   error "Don't know how to load shared libraries on this platform."

 #endif // OS
 
 // ---------------------------------------------------------------------------
 #endif // OS
 
 // ---------------------------------------------------------------------------


@@ -76,33 +110,20 @@
 
 wxLibraries wxTheLibraries;
 
 
 wxLibraries wxTheLibraries;
 

-// ----------------------------------------------------------------------------
-// private functions
-// ----------------------------------------------------------------------------
+// ============================================================================
+// implementation
+// ============================================================================

 
 // construct the full name from the base shared object name: adds a .dll
 // suffix under Windows or .so under Unix
 static wxString ConstructLibraryName(const wxString& basename)
 {
 
 // construct the full name from the base shared object name: adds a .dll
 // suffix under Windows or .so under Unix
 static wxString ConstructLibraryName(const wxString& basename)
 {

-    wxString fullname(basename);
-
-#if defined(__UNIX__)
-    #if defined(__HPUX__)
-        fullname << ".sl";
-    #else      //__HPUX__
-        fullname << ".so";
-    #endif     //__HPUX__
-#elif defined(__WINDOWS__)
-    fullname << ".dll";
-#endif
+    wxString fullname;
+    fullname << basename << wxDllLoader::GetDllExt();

 
     return fullname;
 }
 
 
     return fullname;
 }
 

-// ============================================================================
-// implementation
-// ============================================================================
-

 // ---------------------------------------------------------------------------
 // wxLibrary (one instance per dynamic library)
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // wxLibrary (one instance per dynamic library)
 // ---------------------------------------------------------------------------


@@ -147,7 +168,7 @@ void wxLibrary::PrepareClasses(wxClassInfo *first)
     {
         if (info->m_className)
             classTable.Put(info->m_className, (wxObject *)info);
     {
         if (info->m_className)
             classTable.Put(info->m_className, (wxObject *)info);

-        info = info->GetNext();
+        info = (wxClassInfo *)info->GetNext();

     }
 
     // Set base pointers for each wxClassInfo
     }
 
     // Set base pointers for each wxClassInfo


@@ -163,31 +184,153 @@ void wxLibrary::PrepareClasses(wxClassInfo *first)
 }
 
 void *wxLibrary::GetSymbol(const wxString& symbname)
 }
 
 void *wxLibrary::GetSymbol(const wxString& symbname)

+{
+   return wxDllLoader::GetSymbol(m_handle, symbname);
+}
+
+// ---------------------------------------------------------------------------
+// wxDllLoader
+// ---------------------------------------------------------------------------
+
+/* static */
+wxString wxDllLoader::GetDllExt()
+{
+    wxString ext;
+
+#if defined(__WINDOWS__) || defined(__WXPM__) || defined(__EMX__)
+    ext = _T(".dll");
+#elif defined(__UNIX__)
+#   if defined(__HPUX__)
+        ext = _T(".sl");
+#   else //__HPUX__
+        ext = _T(".so");
+#   endif //__HPUX__
+#endif
+
+    return ext;
+}
+
+/* static */
+wxDllType
+wxDllLoader::GetProgramHandle(void)
+{
+#if defined( HAVE_DLOPEN ) && !defined(__EMX__)
+   // optain handle for main program
+   return dlopen(NULL, RTLD_NOW/*RTLD_LAZY*/);
+#elif defined (HAVE_SHL_LOAD)
+   // shl_findsymbol with NULL handle looks up in main program
+   return 0;
+#else
+   wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2"));
+   return 0;
+#endif
+}
+
+/* static */
+wxDllType
+wxDllLoader::LoadLibrary(const wxString & libname, bool *success)
+{
+    wxDllType handle;
+
+#if defined(__WXMAC__) && !defined(__UNIX__)
+    FSSpec myFSSpec ;
+    Ptr myMainAddr ;
+    Str255 myErrName ;
+
+    wxMacFilename2FSSpec( libname , &myFSSpec ) ;
+    if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr ,
+                myErrName ) != noErr )
+    {
+        p2cstr( myErrName ) ;
+        wxLogSysError( _("Failed to load shared library '%s' Error '%s'") , libname.c_str() , (char*)myErrName ) ;
+        handle = NULL ;
+    }
+#elif defined(__WXPM__) || defined(__EMX__)
+    char zError[256] = "";
+    wxDllOpen(zError, libname, handle);
+#else // !Mac
+    handle = wxDllOpen(libname);
+#endif // OS
+
+    if ( !handle )
+    {
+        wxString msg(_("Failed to load shared library '%s'"));
+
+#ifdef HAVE_DLERROR
+        const char *errmsg = dlerror();
+        if ( errmsg )
+        {
+            // the error string format is "libname: ...", but we already have
+            // libname, so cut it off
+            const char *p = strchr(errmsg, ':');
+            if ( p )
+            {
+                if ( *++p == ' ' )
+                    p++;
+            }
+            else
+            {
+                p = errmsg;
+            }
+
+            msg += _T(" (%s)");
+            wxLogError(msg, libname.c_str(), p);
+        }
+        else
+#endif // HAVE_DLERROR
+        {
+            wxLogSysError(msg, libname.c_str());
+        }
+    }
+
+    if ( success )
+    {
+        *success = handle != 0;
+    }
+
+    return handle;
+}
+
+
+/* static */
+void
+wxDllLoader::UnloadLibrary(wxDllType handle)
+{
+   wxDllClose(handle);
+}
+
+/* static */
+void *
+wxDllLoader::GetSymbol(wxDllType dllHandle, const wxString &name)

 {
     void *symbol = NULL;    // return value
 
 {
     void *symbol = NULL;    // return value
 

-#if defined( __WXMAC__ )
+#if defined(__WXMAC__) && !defined(__UNIX__)

     Ptr symAddress ;
     CFragSymbolClass symClass ;
     Ptr symAddress ;
     CFragSymbolClass symClass ;

-    Str255     symName ;
+    Str255 symName ;

 
 

-    strcpy( (char*) symName , symbname ) ;
-    c2pstr( (char*) symName ) ;
+#if TARGET_CARBON
+    c2pstrcpy( (StringPtr) symName , name ) ;
+#else
+    strcpy( (char *) symName , name ) ;
+       c2pstr( (char *) symName ) ;
+#endif

 
 

-    if ( FindSymbol( m_handle , symName , &symAddress , &symClass ) == noErr )
-    {
-        symbol = (void *)symAddress ; 
-    }
+    if ( FindSymbol( dllHandle , symName , &symAddress , &symClass ) == noErr )
+        symbol = (void *)symAddress ;
+#elif defined( __WXPM__ ) || defined(__EMX__)
+    wxDllGetSymbol(dllHandle, symbol);

 #else
 #else

-    symbol = wxDllGetSymbol(m_handle, symbname);
+    // mb_str() is necessary in Unicode build
+    symbol = wxDllGetSymbol(dllHandle, name.mb_str());

 #endif
 
     if ( !symbol )
     {
         wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
 #endif
 
     if ( !symbol )
     {
         wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),

-                      symbname.c_str());
+                      name.c_str());

     }
     }

-

     return symbol;
 }
 
     return symbol;
 }
 


@@ -195,7 +338,7 @@ void *wxLibrary::GetSymbol(const wxString& symbname)
 // wxLibraries (only one instance should normally exist)
 // ---------------------------------------------------------------------------
 
 // wxLibraries (only one instance should normally exist)
 // ---------------------------------------------------------------------------
 

-wxLibraries::wxLibraries()
+wxLibraries::wxLibraries():m_loaded(wxKEY_STRING)

 {
 }
 
 {
 }
 


@@ -217,30 +360,39 @@ wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
     wxLibrary *lib;
     wxClassInfo *old_sm_first;
 
     wxLibrary *lib;
     wxClassInfo *old_sm_first;
 

-    if ( (node = m_loaded.Find(name.GetData())) )
+#if defined(__VISAGECPP__)
+    node = m_loaded.Find(name.GetData());
+    if (node != NULL)

         return ((wxLibrary *)node->Data());
         return ((wxLibrary *)node->Data());

-
+#else // !OS/2
+    if ( (node = m_loaded.Find(name.GetData())) != NULL)
+        return ((wxLibrary *)node->Data());
+#endif

     // If DLL shares data, this is necessary.
     old_sm_first = wxClassInfo::sm_first;
     wxClassInfo::sm_first = NULL;
 
     // If DLL shares data, this is necessary.
     old_sm_first = wxClassInfo::sm_first;
     wxClassInfo::sm_first = NULL;
 

-    wxString lib_name = ConstructLibraryName(name);
+    wxString libname = 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
     const char *envLibPath = getenv("LD_LIBRARY_PATH");
     if ( envLibPath )
 #if defined(__UNIX__)
     // found the first file in LD_LIBRARY_PATH with this name
     wxString libPath("/lib:/usr/lib"); // system path first
     const char *envLibPath = getenv("LD_LIBRARY_PATH");
     if ( envLibPath )

-        libPath << ':' << envLibPath;
-    wxStringTokenizer tokenizer(libPath, _T(':'));
+        libPath << wxT(':') << envLibPath;
+    wxStringTokenizer tokenizer(libPath, wxT(':'));

     while ( tokenizer.HasMoreToken() )
     {
         wxString fullname(tokenizer.NextToken());
 
     while ( tokenizer.HasMoreToken() )
     {
         wxString fullname(tokenizer.NextToken());
 

-        fullname << '/' << lib_name;
+        fullname << wxT('/') << libname;

         if ( wxFileExists(fullname) )
         {
         if ( wxFileExists(fullname) )
         {

-            lib_name = fullname;
+            libname = fullname;

 
             // found the library
             break;
 
             // found the library
             break;


@@ -249,40 +401,18 @@ wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
     //else: not found in the path, leave the name as is (secutiry risk?)
 
 #endif // __UNIX__
     //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 = FALSE;
+    wxDllType handle = wxDllLoader::LoadLibrary(libname, &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;
 }
 
     return lib;
 }