removed obsolete file

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

diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp
index 57820da629098cdbd7667352ae472033d87d7072..3660cc21f81211392d5d2fddb3cf28be82a286d1 100644 (file)
--- a/src/common/dynlib.cpp
+++ b/src/common/dynlib.cpp
@@ -18,59 +18,96 @@
 // ----------------------------------------------------------------------------
 
 #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__
-
-// TODO should be done by configure
-#if defined(__UNIX__) && !(defined(HAVE_DLOPEN) || defined(HAVE_SHLLOAD))
-    #if defined(__LINUX__) || defined(__SOLARIS__) || defined(__SUNOS__) || defined(__FREEBSD__)
-        #ifndef HAVE_DLOPEN
-            #define HAVE_DLOPEN
-        #endif
-    #elif defined(__HPUX__)
-        #ifndef HAVE_SHLLOAD
-            #define HAVE_SHLLOAD
-        #endif
-    #endif // Unix flavour
-#endif // !Unix or already have some HAVE_xxx defined
+#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"
 #include "wx/log.h"
 
 #include "wx/dynlib.h"
 #include "wx/filefn.h"
 #include "wx/intl.h"
 #include "wx/log.h"

+#include "wx/tokenzr.h"

 
 // ----------------------------------------------------------------------------
 // conditional compilation
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // conditional compilation
 // ----------------------------------------------------------------------------
 

-#if defined(HAVE_DLOPEN)
-    #define wxDllOpen(lib)                dlopen(lib, RTLD_LAZY)
-    #define wxDllGetSymbol(handle, name)  dlsym(handle, (char *)name)
-    #define wxDllClose                    dlclose
-#elif defined(HAVE_SHLLOAD)
-    #define wxDllOpen(lib)                shl_open(lib, BIND_DEFERRED, 0)
-    #define wxDllClose      shl_unload
+#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

 
 

-    static inline void *wxDllGetSymbol(shl_t *handle, const char *name)
+    static inline void *wxDllGetSymbol(shl_t handle, const wxString& name)

     {
         void *sym;
     {
         void *sym;

-        if ( shl_findsym(handle, name, TYPE_UNDEFINED, &sym) == 0 )
+        if ( shl_findsym(&handle, name.mb_str(), TYPE_UNDEFINED, &sym) == 0 )

             return sym;
         else
             return (void *)0;
     }
             return sym;
         else
             return (void *)0;
     }

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

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

-    #define wxDllOpen(lib)                  ::LoadLibrary(lib)
-    #define wxDllGetSymbol(handle, name)    ::GetProcAddress(handle, name)
-    #define wxDllClose                      ::FreeLibrary
+    // using LoadLibraryEx under Win32 to avoid name clash with LoadLibrary
+#   ifdef __WIN32__
+#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(__WXMAC__)
+#   define wxDllClose(handle)               CloseConnection(&handle)

 #else
 #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
 
 // ---------------------------------------------------------------------------
 #endif // OS
 
 // ---------------------------------------------------------------------------


@@ -79,29 +116,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__)
-    fullname << ".so";
-#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)
 // ---------------------------------------------------------------------------


@@ -146,7 +174,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


@@ -162,33 +190,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

-    // VZ: hmm... why is WXSTRINGCAST needed? if it's really modified, we
-    //     should make a copy of it
-    symbol = wxDllGetSymbol(m_handle, WXSTRINGCAST 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;
 }
 


@@ -196,7 +344,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)

 {
 }
 
 {
 }
 


@@ -218,53 +366,59 @@ 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__)
 #if defined(__UNIX__)

-    // TODO use LD_LIBRARY_PATH!
-    lib_name.Prepend("/lib");
-#endif // __UNIX__
-
-    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 )
+    // 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 << wxT(':') << envLibPath;
+    wxStringTokenizer tokenizer(libPath, wxT(':'));
+    while ( tokenizer.HasMoreToken() )

     {
     {

-        p2cstr( myErrName ) ;
-        wxASSERT_MSG( 1 , (char*)myErrName ) ;
-        return NULL ;
-    }
-#else // !Mac
-    handle = wxDllOpen(lib_name);
-#endif // OS
+        wxString fullname(tokenizer.NextToken());

 
 

-    if ( !handle )
-    {
-        wxLogSysError(_("Failed to load shared library '%s'"),
-                      lib_name.c_str());
+        fullname << wxT('/') << libname;
+        if ( wxFileExists(fullname) )
+        {
+            libname = fullname;

 
 

-        return NULL;
+            // found the library
+            break;
+        }

     }
     }

+    //else: not found in the path, leave the name as is (secutiry risk?)

 
 

-    lib = new wxLibrary(handle);
-
-    wxClassInfo::sm_first = old_sm_first;
-
-    m_loaded.Append(name.GetData(), lib);
+#endif // __UNIX__
+#endif

 
 

+    bool success = FALSE;
+    wxDllType handle = wxDllLoader::LoadLibrary(libname, &success);
+    if(success)
+    {
+       lib = new wxLibrary(handle);
+       wxClassInfo::sm_first = old_sm_first;
+       m_loaded.Append(name.GetData(), lib);
+    }
+    else
+       lib = NULL;

     return lib;
 }
 
     return lib;
 }
 


@@ -282,3 +436,101 @@ wxObject *wxLibraries::CreateObject(const wxString& path)
     }
     return NULL;
 }
     }
     return NULL;
 }

+
+#ifdef __DARWIN__
+// ---------------------------------------------------------------------------
+// For Darwin/Mac OS X
+//   supply the sun style dlopen functions in terms of Darwin NS*
+// ---------------------------------------------------------------------------
+
+extern "C" {
+#import <mach-o/dyld.h>
+};
+
+enum dyldErrorSource
+{
+    OFImage,
+};
+
+static char dl_last_error[1024];
+
+static
+void TranslateError(const char *path, enum dyldErrorSource type, int number)
+{
+    unsigned int index;
+    static char *OFIErrorStrings[] =
+    {
+       "%s(%d): Object Image Load Failure\n",
+       "%s(%d): Object Image Load Success\n",
+       "%s(%d): Not an recognisable object file\n",
+       "%s(%d): No valid architecture\n",
+       "%s(%d): Object image has an invalid format\n",
+       "%s(%d): Invalid access (permissions?)\n",
+       "%s(%d): Unknown error code from NSCreateObjectFileImageFromFile\n",
+    };
+#define NUM_OFI_ERRORS (sizeof(OFIErrorStrings) / sizeof(OFIErrorStrings[0]))
+
+    switch (type)
+    {
+     case OFImage:
+        index = number;
+        if (index > NUM_OFI_ERRORS - 1) {
+            index = NUM_OFI_ERRORS - 1;
+        }
+        sprintf(dl_last_error, OFIErrorStrings[index], path, number);
+        break;
+        
+     default:
+        sprintf(dl_last_error, "%s(%d): Totally unknown error type %d\n",
+                path, number, type);
+        break;
+    }
+}
+
+const char *dlerror()
+{
+    return dl_last_error;
+}
+
+void *dlopen(const char *path, int mode /* mode is ignored */)
+{
+    int dyld_result;
+    NSObjectFileImage ofile;
+    NSModule handle = NULL;
+
+    dyld_result = NSCreateObjectFileImageFromFile(path, &ofile);
+    if (dyld_result != NSObjectFileImageSuccess)
+    {
+       TranslateError(path, OFImage, dyld_result);
+    }
+    else
+    {
+       // NSLinkModule will cause the run to abort on any link error's
+       // not very friendly but the error recovery functionality is limited.
+       handle = NSLinkModule(ofile, path, TRUE);
+    }
+
+    return handle;
+}
+
+int dlclose(void *handle) /* stub only */
+{
+    return 0;
+}
+
+void *dlsym(void *handle, const char *symbol)
+{
+    void *addr;
+
+    if (NSIsSymbolNameDefined(symbol)) {
+       addr = NSAddressOfSymbol(NSLookupAndBindSymbol(symbol));
+    }
+    else {
+       addr = NULL;
+    }
+    return addr;
+}
+
+#endif // __DARWIN__
+
+#endif // wxUSE_DYNLIB_CLASS