check for LVS_OWNERDATA availability at compile and run-time
[wxWidgets.git] / src / common / dynlib.cpp
index a3158210e28d26848bc82e2519b66061f59e8938..5c93399eee466932826be97f12f5e5d33360eb31 100644 (file)
 #ifdef __BORLANDC__
   #pragma hdrstop
 #endif
+
 #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"
 // conditional compilation
 // ----------------------------------------------------------------------------
 
-#if defined(HAVE_DLOPEN)
-#   define wxDllOpen(lib)                dlopen(lib.fn_str(), RTLD_NOW/*RTLD_LAZY*/)
-#   define wxDllGetSymbol(handle, name)  dlsym(handle, name.mb_str())
+#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)
 #   define wxDllOpen(lib)                shl_load(lib.fn_str(), BIND_DEFERRED, 0)
-#   define wxDllClose      shl_unload
+#   define wxDllClose                    shl_unload
 
     static inline void *wxDllGetSymbol(shl_t handle, const wxString& name)
     {
         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__)
-#   include <windows.h>
-
     // using LoadLibraryEx under Win32 to avoid name clash with LoadLibrary
 #   ifdef __WIN32__
-#      define wxDllOpen(lib)                  ::LoadLibraryEx(lib, 0, 0)
+#ifdef _UNICODE
+#      define wxDllOpen(lib)                  ::LoadLibraryExW(lib, 0, 0)
+#else
+#      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(__OS2__)
-
-#  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(__WXMAC__)
+#   define wxDllClose(handle)               CloseConnection(&handle)
 #else
 #   error "Don't know how to load shared libraries on this platform."
 #endif // OS
 
 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)
 {
-    wxString fullname(basename);
-
-#if defined(__UNIX__)
-#   if defined(__HPUX__)
-        fullname << ".sl";
-#   else       //__HPUX__
-        fullname << ".so";
-#   endif      //__HPUX__
-#elif defined(__WINDOWS__) || defined(__OS2__)
-    fullname << ".dll";
-#endif
+    wxString fullname;
+    fullname << basename << wxDllLoader::GetDllExt();
 
     return fullname;
 }
 
-// ============================================================================
-// implementation
-// ============================================================================
-
-
 // ---------------------------------------------------------------------------
 // wxLibrary (one instance per dynamic library)
 // ---------------------------------------------------------------------------
@@ -155,7 +168,7 @@ void wxLibrary::PrepareClasses(wxClassInfo *first)
     {
         if (info->m_className)
             classTable.Put(info->m_className, (wxObject *)info);
-        info = info->GetNext();
+        info = (wxClassInfo *)info->GetNext();
     }
 
     // Set base pointers for each wxClassInfo
@@ -179,18 +192,36 @@ void *wxLibrary::GetSymbol(const wxString& 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 )
+#if defined( HAVE_DLOPEN ) && !defined(__EMX__)
    // optain handle for main program
-   return dlopen(NULL, RTLD_NOW/*RTLD_LAZY*/); 
+   return dlopen(NULL, RTLD_NOW/*RTLD_LAZY*/);
 #elif defined (HAVE_SHL_LOAD)
    // shl_findsymbol with NULL handle looks up in main program
-   return 0; 
+   return 0;
 #else
-   wxFAIL_MSG(_("This method is not implemented under Windows or OS/2"));
+   wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2"));
    return 0;
 #endif
 }
@@ -201,21 +232,21 @@ wxDllLoader::LoadLibrary(const wxString & libname, bool *success)
 {
     wxDllType handle;
 
-#if defined(__WXMAC__)
+#if defined(__WXMAC__) && !defined(__UNIX__)
     FSSpec myFSSpec ;
-    Ptr        myMainAddr ;
-    Str255     myErrName ;
+    Ptr myMainAddr ;
+    Str255 myErrName ;
 
-    wxMacPathToFSSpec( libname , &myFSSpec ) ;
+    wxMacFilename2FSSpec( libname , &myFSSpec ) ;
     if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr ,
                 myErrName ) != noErr )
     {
         p2cstr( myErrName ) ;
-        wxASSERT_MSG( 1 , (char*)myErrName ) ;
-        return NULL ;
+        wxLogSysError( _("Failed to load shared library '%s' Error '%s'") , libname.c_str() , (char*)myErrName ) ;
+        handle = NULL ;
     }
-#elif defined(__OS2__)
-    char                            zError[256] = "";
+#elif defined(__WXPM__) || defined(__EMX__)
+    char zError[256] = "";
     wxDllOpen(zError, libname, handle);
 #else // !Mac
     handle = wxDllOpen(libname);
@@ -223,7 +254,33 @@ wxDllLoader::LoadLibrary(const wxString & libname, bool *success)
 
     if ( !handle )
     {
-        wxLogSysError(_("Failed to load shared library '%s'"), libname.c_str());
+        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 )
@@ -248,20 +305,25 @@ wxDllLoader::GetSymbol(wxDllType dllHandle, const wxString &name)
 {
     void *symbol = NULL;    // return value
 
-#if defined( __WXMAC__ )
+#if defined(__WXMAC__) && !defined(__UNIX__)
     Ptr symAddress ;
     CFragSymbolClass symClass ;
-    Str255     symName ;
+    Str255 symName ;
 
-    strcpy( (char*) symName , name ) ;
-    c2pstr( (char*) 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( __OS2__ )
+#elif defined( __WXPM__ ) || defined(__EMX__)
     wxDllGetSymbol(dllHandle, symbol);
 #else
-    symbol = wxDllGetSymbol(dllHandle, name);
+    // mb_str() is necessary in Unicode build
+    symbol = wxDllGetSymbol(dllHandle, name.mb_str());
 #endif
 
     if ( !symbol )
@@ -303,7 +365,7 @@ wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
     if (node != NULL)
         return ((wxLibrary *)node->Data());
 #else // !OS/2
-    if ( (node = m_loaded.Find(name.GetData())) )
+    if ( (node = m_loaded.Find(name.GetData())) != NULL)
         return ((wxLibrary *)node->Data());
 #endif
     // If DLL shares data, this is necessary.
@@ -321,13 +383,13 @@ wxLibrary *wxLibraries::LoadLibrary(const wxString& 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());
 
-        fullname << '/' << libname;
+        fullname << wxT('/') << libname;
         if ( wxFileExists(fullname) )
         {
             libname = fullname;