]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/dynlib.cpp
better spacing
[wxWidgets.git] / src / common / dynlib.cpp
index 3aa8cc8758618e03840a2f0bb3b766f6ca2986a1..f55c803348a2592ce75ea01c80ca809aa686ebd9 100644 (file)
@@ -6,7 +6,7 @@
 // Created:     20/07/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
@@ -27,7 +27,7 @@
   #pragma hdrstop
 #endif
 
-#if wxUSE_DYNLIB_CLASS
+#if wxUSE_DYNLIB_CLASS && !wxUSE_DYNAMIC_LOADER
 
 #if defined(__WINDOWS__)
     #include "wx/msw/private.h"
 #include "wx/filefn.h"
 #include "wx/intl.h"
 #include "wx/log.h"
-#include "wx/tokenzr.h"
+
+#if defined(__WXMAC__)
+    #include "wx/mac/private.h"
+#endif
 
 // ----------------------------------------------------------------------------
 // conditional compilation
 #  define wxDllGetSymbol(handle, modaddr)   DosQueryProcAddr(handle, 1L, NULL, (PFN*)modaddr)
 #  define wxDllClose(handle)                DosFreeModule(handle)
 #elif defined(HAVE_DLOPEN)
-#   define wxDllOpen(lib)                dlopen(lib.fn_str(), RTLD_NOW/*RTLD_LAZY*/)
-#   define wxDllGetSymbol(handle, name)  dlsym(handle, name)
+    // 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)
-    {
-        void *sym;
-        if ( shl_findsym(&handle, name.mb_str(), TYPE_UNDEFINED, &sym) == 0 )
-            return sym;
-        else
-            return (void *)0;
-    }
+static inline void *wxDllGetSymbol(shl_t handle, const wxString& name)
+{
+    void *sym;
+    if ( shl_findsym(&handle, name.mb_str(), TYPE_UNDEFINED, &sym) == 0 )
+        return sym;
+    else
+        return 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__)
     // using LoadLibraryEx under Win32 to avoid name clash with LoadLibrary
 #   ifdef __WIN32__
 #   endif  // Win32/16
 #   define wxDllGetSymbol(handle, name)    ::GetProcAddress(handle, name)
 #   define wxDllClose                      ::FreeLibrary
+#elif defined(__WXMAC__)
+#   define wxDllClose(handle)               CloseConnection(&((CFragConnectionID)handle))
 #else
 #   error "Don't know how to load shared libraries on this platform."
 #endif // OS
@@ -114,7 +146,7 @@ wxLibrary::wxLibrary(wxDllType handle)
     m_handle = handle;
 
     // Some system may use a local heap for library.
-    get_first = (t_get_first)GetSymbol("wxGetClassFirst");
+    get_first = (t_get_first)GetSymbol(_T("wxGetClassFirst"));
     // It is a wxWindows DLL.
     if (get_first)
         PrepareClasses(get_first());
@@ -146,7 +178,7 @@ void wxLibrary::PrepareClasses(wxClassInfo *first)
     {
         if (info->m_className)
             classTable.Put(info->m_className, (wxObject *)info);
-        info = info->GetNext();
+        info = info->m_next;
     }
 
     // Set base pointers for each wxClassInfo
@@ -170,34 +202,28 @@ void *wxLibrary::GetSymbol(const wxString& symbname)
 // wxDllLoader
 // ---------------------------------------------------------------------------
 
-/* static */
-wxString wxDllLoader::GetDllExt()
-{
-    wxString ext;
 
 #if defined(__WINDOWS__) || defined(__WXPM__) || defined(__EMX__)
-    ext = _T(".dll");
+const wxString wxDllLoader::ms_dllext( _T(".dll") );
 #elif defined(__UNIX__)
-#   if defined(__HPUX__)
-        ext = _T(".sl");
-#   else //__HPUX__
-        ext = _T(".so");
-#   endif //__HPUX__
+#if defined(__HPUX__)
+const wxString wxDllLoader::ms_dllext( _T(".sl") );
+#else
+const wxString wxDllLoader::ms_dllext( _T(".so") );
+#endif
+#elif defined(__WXMAC__)
+const wxString wxDllLoader::ms_dllext( _T("") );
 #endif
-
-    return ext;
-}
 
 /* static */
-wxDllType
-wxDllLoader::GetProgramHandle(void)
+wxDllType wxDllLoader::GetProgramHandle()
 {
 #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( wxT("This method is not implemented under Windows or OS/2"));
    return 0;
@@ -205,106 +231,120 @@ wxDllLoader::GetProgramHandle(void)
 }
 
 /* static */
-wxDllType
-wxDllLoader::LoadLibrary(const wxString & libname, bool *success)
+wxDllType wxDllLoader::LoadLibrary(const wxString & libname, bool *success)
 {
-    wxDllType handle;
-
-#if defined(__WXMAC__)
-    FSSpec myFSSpec ;
-    Ptr myMainAddr ;
-    Str255 myErrName ;
-
-    wxMacPathToFSSpec( libname , &myFSSpec ) ;
-    if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr ,
-                myErrName ) != noErr )
+    wxDllType   handle;
+    bool        failed = FALSE;
+
+#if defined(__WXMAC__) && !defined(__UNIX__)
+    FSSpec      myFSSpec;
+    Ptr         myMainAddr;
+    Str255      myErrName;
+
+    wxMacFilename2FSSpec( libname , &myFSSpec );
+
+    if( GetDiskFragment( &myFSSpec,
+                         0,
+                         kCFragGoesToEOF,
+                         "\p",
+                         kPrivateCFragCopy,
+                         &((CFragConnectionID)handle),
+                         &myMainAddr,
+                         myErrName ) != noErr )
     {
-        p2cstr( myErrName ) ;
-        wxASSERT_MSG( 1 , (char*)myErrName ) ;
-        return NULL ;
+        p2cstr( myErrName );
+        wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
+                       libname.c_str(),
+                       (char*)myErrName );
+        handle = 0;
+        failed = TRUE;
     }
+
 #elif defined(__WXPM__) || defined(__EMX__)
-    char zError[256] = "";
+    char        zError[256] = "";
     wxDllOpen(zError, libname, handle);
-#else // !Mac
+
+#else
     handle = wxDllOpen(libname);
-#endif // OS
+
+#endif
 
     if ( !handle )
     {
         wxString msg(_("Failed to load shared library '%s'"));
 
 #ifdef HAVE_DLERROR
-        const char *errmsg = dlerror();
-        if ( errmsg )
+        const wxChar *err = dlerror();
+        if( err )
         {
-            // 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());
+            failed = TRUE;
+            wxLogError( msg, err );
         }
+#else
+        failed = TRUE;
+        wxLogSysError( msg, libname.c_str() );
+#endif
     }
 
     if ( success )
-    {
-        *success = handle != 0;
-    }
+        *success = !failed;
 
     return handle;
 }
 
 
 /* static */
-void
-wxDllLoader::UnloadLibrary(wxDllType handle)
+void wxDllLoader::UnloadLibrary(wxDllType handle)
 {
    wxDllClose(handle);
 }
 
 /* static */
-void *
-wxDllLoader::GetSymbol(wxDllType dllHandle, const wxString &name)
+void *wxDllLoader::GetSymbol(wxDllType dllHandle, const wxString &name, bool *success)
 {
-    void *symbol = NULL;    // return value
+    bool    failed = FALSE;
+    void    *symbol = 0;
+
+#if defined(__WXMAC__) && !defined(__UNIX__)
+    Ptr                 symAddress;
+    CFragSymbolClass    symClass;
+    Str255              symName;
 
-#if defined( __WXMAC__ )
-    Ptr symAddress ;
-    CFragSymbolClass symClass ;
-    Str255 symName ;
+       wxMacStringToPascal( name.c_str() , symName ) ;
 
-    strcpy( (char*) symName , name ) ;
-    c2pstr( (char*) symName ) ;
+    if( FindSymbol( ((CFragConnectionID)dllHandle), symName, &symAddress, &symClass ) == noErr )
+        symbol = (void *)symAddress;
 
-    if ( FindSymbol( dllHandle , symName , &symAddress , &symClass ) == noErr )
-        symbol = (void *)symAddress ;
-#elif defined( __WXPM__ ) || defined(__EMX__)
+#elif defined(__WXPM__) || defined(__EMX__)
     wxDllGetSymbol(dllHandle, symbol);
-#else
+
+#else // Windows or Unix
+
     // mb_str() is necessary in Unicode build
-    symbol = wxDllGetSymbol(dllHandle, name.mb_str());
-#endif
+    //
+    // "void *" cast is needed by gcc 3.1 + w32api 1.4, don't ask me why
+    symbol = (void *)wxDllGetSymbol(dllHandle, name.mb_str());
+
+#endif // OS
 
     if ( !symbol )
     {
+#ifdef HAVE_DLERROR
+        const wxChar *err = dlerror();
+        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;
 }
 
@@ -330,59 +370,26 @@ wxLibraries::~wxLibraries()
 
 wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
 {
-    wxNode *node;
-    wxLibrary *lib;
+    wxLibrary   *lib;
     wxClassInfo *old_sm_first;
+    wxNode      *node = m_loaded.Find(name.GetData());
 
-#if defined(__VISAGECPP__)
-    node = m_loaded.Find(name.GetData());
     if (node != NULL)
         return ((wxLibrary *)node->Data());
-#else // !OS/2
-    if ( (node = m_loaded.Find(name.GetData())) )
-        return ((wxLibrary *)node->Data());
-#endif
+
     // If DLL shares data, this is necessary.
     old_sm_first = wxClassInfo::sm_first;
     wxClassInfo::sm_first = NULL;
 
     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 )
-        libPath << wxT(':') << envLibPath;
-    wxStringTokenizer tokenizer(libPath, wxT(':'));
-    while ( tokenizer.HasMoreToken() )
-    {
-        wxString fullname(tokenizer.NextToken());
-
-        fullname << wxT('/') << libname;
-        if ( wxFileExists(fullname) )
-        {
-            libname = fullname;
-
-            // found the library
-            break;
-        }
-    }
-    //else: not found in the path, leave the name as is (secutiry risk?)
-
-#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
@@ -405,4 +412,85 @@ wxObject *wxLibraries::CreateObject(const wxString& path)
     return NULL;
 }
 
-#endif // wxUSE_DYNLIB_CLASS
+#endif // wxUSE_DYNLIB_CLASS && !wxUSE_DYNAMIC_LOADER
+
+#if defined(__DARWIN__) && (wxUSE_DYNLIB_CLASS || wxUSE_DYNAMIC_LOADER)
+// ---------------------------------------------------------------------------
+// For Darwin/Mac OS X
+//   supply the sun style dlopen functions in terms of Darwin NS*
+// ---------------------------------------------------------------------------
+
+#include <stdio.h>
+#include <mach-o/dyld.h>
+
+static char dl_last_error[1024];
+
+static
+void TranslateError(const char *path, 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]))
+
+    index = number;
+    if (index > NUM_OFI_ERRORS - 1) {
+        index = NUM_OFI_ERRORS - 1;
+    }
+    sprintf(dl_last_error, OFIErrorStrings[index], path, number);
+}
+
+const char *dlerror()
+{
+    return dl_last_error;
+}
+
+void *dlopen(const char *path, int WXUNUSED(mode) /* mode is ignored */)
+{
+    int dyld_result;
+    NSObjectFileImage ofile;
+    NSModule handle = NULL;
+
+    dyld_result = NSCreateObjectFileImageFromFile(path, &ofile);
+    if (dyld_result != NSObjectFileImageSuccess)
+    {
+       TranslateError(path, 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, NSLINKMODULE_OPTION_BINDNOW);
+    }
+
+    return handle;
+}
+
+int dlclose(void *handle)
+{
+    NSUnLinkModule( handle, NSUNLINKMODULE_OPTION_NONE);
+    return 0;
+}
+
+void *dlsym(void *WXUNUSED(handle), const char *symbol)
+{
+    void *addr;
+
+    if (NSIsSymbolNameDefined(symbol)) {
+       addr = NSAddressOfSymbol(NSLookupAndBindSymbol(symbol));
+    }
+    else {
+       addr = NULL;
+    }
+    return addr;
+}
+
+#endif // defined(__DARWIN__) && (wxUSE_DYNLIB_CLASS || wxUSE_DYNAMIC_LOADER)