LIB instead of Static, better aligned

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

diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp
index 447fb80a87e7026eded1bc30861bd8ae218a354f..2d3ce5dfec9be581b4f52957679f6e20f2e358dd 100644 (file)
--- a/src/common/dynlib.cpp
+++ b/src/common/dynlib.cpp
@@ -6,7 +6,7 @@
 // Created:     20/07/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux
 // Created:     20/07/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -18,282 +18,467 @@
 // ----------------------------------------------------------------------------
 
 #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/log.h"
 #include "wx/dynlib.h"
 #include "wx/filefn.h"
 #include "wx/intl.h"
 #include "wx/log.h"

-#include "wx/tokenzr.h"
-
-// ----------------------------------------------------------------------------
-// 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_SHL_LOAD)
-    #define wxDllOpen(lib)                shl_load(lib, BIND_DEFERRED, 0)
-    #define wxDllClose      shl_unload
-
-    static inline void *wxDllGetSymbol(shl_t handle, const char *name)
-    {
-        void *sym;
-        if ( shl_findsym(&handle, name, TYPE_UNDEFINED, &sym) == 0 )
-            return sym;
-        else
-            return (void *)0;
-    }
-#elif defined(__WINDOWS__)
-    #define wxDllOpen(lib)                  ::LoadLibrary(lib)
-    #define wxDllGetSymbol(handle, name)    ::GetProcAddress(handle, name)
-    #define wxDllClose                      ::FreeLibrary
-#else
-    #error "Don't know how to load shared libraries on this platform."
-#endif // OS
+#include "wx/utils.h"
+#include "wx/filename.h"        // for SplitPath()

 
 

-// ---------------------------------------------------------------------------
-// Global variables
-// ---------------------------------------------------------------------------
-
-wxLibraries wxTheLibraries;
-
-// ----------------------------------------------------------------------------
-// private functions
-// ----------------------------------------------------------------------------
-
-// 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";
+#if defined(__WXMAC__)
+    #include "wx/mac/private.h"

 #endif
 
 #endif
 

-    return fullname;
-}

 
 // ============================================================================
 // implementation
 // ============================================================================
 
 
 // ============================================================================
 // implementation
 // ============================================================================
 

+#if defined(__DARWIN__)

 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------

-// wxLibrary (one instance per dynamic library)
+// For Darwin/Mac OS X
+//   supply the sun style dlopen functions in terms of Darwin NS*

 // ---------------------------------------------------------------------------
 
 // ---------------------------------------------------------------------------
 

-wxLibrary::wxLibrary(wxDllType handle)
-{
-    typedef wxClassInfo *(*t_get_first)(void);
-    t_get_first get_first;
+/* 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*.
+ */

 
 

-    m_handle = handle;
+#include <stdio.h>
+#include <mach-o/dyld.h>

 
 

-    // Some system may use a local heap for library.
-    get_first = (t_get_first)GetSymbol("wxGetClassFirst");
-    // It is a wxWindows DLL.
-    if (get_first)
-        PrepareClasses(get_first());
-}
+static char dl_last_error[1024];

 
 

-wxLibrary::~wxLibrary()
+static
+void TranslateError(const char *path, int number)

 {
 {

-    if ( m_handle )
+    unsigned int index;
+    static char *OFIErrorStrings[] =

     {
     {

-        wxDllClose(m_handle);
+       "%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);

 }
 
 }
 

-wxObject *wxLibrary::CreateObject(const wxString& name)
+const char *dlerror()

 {
 {

-    wxClassInfo *info = (wxClassInfo *)classTable.Get(name);
-
-    if (!info)
-        return NULL;
-
-    return info->CreateObject();
+    return dl_last_error;

 }
 
 }
 

-void wxLibrary::PrepareClasses(wxClassInfo *first)
+void *dlopen(const char *path, int WXUNUSED(mode) /* mode is ignored */)

 {
 {

-    // Index all class infos by their class name
-    wxClassInfo *info = first;
-    while (info)
+    int dyld_result;
+    NSObjectFileImage ofile;
+    NSModule handle = NULL;
+
+    dyld_result = NSCreateObjectFileImageFromFile(path, &ofile);
+    if (dyld_result != NSObjectFileImageSuccess)

     {
     {

-        if (info->m_className)
-            classTable.Put(info->m_className, (wxObject *)info);
-        info = info->GetNext();
+       TranslateError(path, dyld_result);

     }
     }

-
-    // Set base pointers for each wxClassInfo
-    info = first;
-    while (info)
+    else

     {
     {

-        if (info->GetBaseClassName1())
-            info->m_baseInfo1 = (wxClassInfo *)classTable.Get(info->GetBaseClassName1());
-        if (info->GetBaseClassName2())
-            info->m_baseInfo2 = (wxClassInfo *)classTable.Get(info->GetBaseClassName2());
-        info = info->m_next;
+       // 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;

 }
 
 }
 

-void *wxLibrary::GetSymbol(const wxString& symbname)
+int dlclose(void *handle)

 {
 {

-    void *symbol = NULL;    // return value
-
-#if defined( __WXMAC__ )
-    Ptr symAddress ;
-    CFragSymbolClass symClass ;
-    Str255     symName ;
+    NSUnLinkModule( handle, NSUNLINKMODULE_OPTION_NONE);
+    return 0;
+}

 
 

-    strcpy( (char*) symName , symbname ) ;
-    c2pstr( (char*) symName ) ;
+void *dlsym(void *handle, const char *symbol)
+{
+    void *addr;
+    
+    NSSymbol nsSymbol = NSLookupSymbolInModule( handle , symbol ) ;

 
 

-    if ( FindSymbol( m_handle , symName , &symAddress , &symClass ) == noErr )
+    if ( nsSymbol) 

     {
     {

-        symbol = (void *)symAddress ; 
+           addr = NSAddressOfSymbol(nsSymbol);

     }
     }

-#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);
-#endif
-
-    if ( !symbol )
+    else 

     {
     {

-        wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
-                      symbname.c_str());
+           addr = NULL;

     }
     }

-
-    return symbol;
+    return addr;

 }
 
 }
 

+#endif // defined(__DARWIN__)
+
+

 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------

-// wxLibraries (only one instance should normally exist)
+// wxDynamicLibrary

 // ---------------------------------------------------------------------------
 
 // ---------------------------------------------------------------------------
 

-wxLibraries::wxLibraries()
+//FIXME:  This class isn't really common at all, it should be moved into
+//        platform dependent files.
+
+#if defined(__WINDOWS__) || defined(__WXPM__) || defined(__EMX__)
+    const wxChar *wxDynamicLibrary::ms_dllext = _T(".dll");
+#elif defined(__UNIX__)
+    #if defined(__HPUX__)
+        const wxChar *wxDynamicLibrary::ms_dllext = _T(".sl");
+    #else
+        const wxChar *wxDynamicLibrary::ms_dllext = _T(".so");
+    #endif
+#endif
+
+wxDllType wxDynamicLibrary::GetProgramHandle()

 {
 {

+#if defined( HAVE_DLOPEN ) && !defined(__EMX__)
+   return dlopen(0, RTLD_LAZY);
+#elif defined (HAVE_SHL_LOAD)
+   return PROG_HANDLE;
+#else
+   wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2"));
+   return 0;
+#endif

 }
 
 }
 

-wxLibraries::~wxLibraries()
+bool wxDynamicLibrary::Load(wxString libname, int flags)

 {
 {

-    wxNode *node = m_loaded.First();
+    wxASSERT_MSG(m_handle == 0, _T("Library already loaded."));

 
 

-    while (node) {
-        wxLibrary *lib = (wxLibrary *)node->Data();
-        delete lib;
-
-        node = node->Next();
+    // add the proper extension for the DLL ourselves unless told not to
+    if ( !(flags & wxDL_VERBATIM) )
+    {
+        // and also check that the libname doesn't already have it
+        wxString ext;
+        wxFileName::SplitPath(libname, NULL, NULL, &ext);
+        if ( ext.empty() )
+        {
+            libname += GetDllExt();
+        }

     }
     }

-}

 
 

-wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
-{
-    wxNode *node;
-    wxLibrary *lib;
-    wxClassInfo *old_sm_first;
-
-    if ( (node = m_loaded.Find(name.GetData())) )
-        return ((wxLibrary *)node->Data());
-
-    // If DLL shares data, this is necessary.
-    old_sm_first = wxClassInfo::sm_first;
-    wxClassInfo::sm_first = NULL;
-
-    wxString lib_name = ConstructLibraryName(name);
-
-#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, ':');
-    while ( tokenizer.HasMoreToken() )
+    // different ways to load a shared library
+    //
+    // FIXME: should go to the platform-specific files!
+#if defined(__WXMAC__) && !defined(__DARWIN__)
+    FSSpec      myFSSpec;
+    Ptr         myMainAddr;
+    Str255      myErrName;
+
+    wxMacFilename2FSSpec( libname , &myFSSpec );
+
+    if( GetDiskFragment( &myFSSpec,
+                         0,
+                         kCFragGoesToEOF,
+                         "\p",
+                         kPrivateCFragCopy,
+                         &m_handle,
+                         &myMainAddr,
+                         myErrName ) != noErr )

     {
     {

-        wxString fullname(tokenizer.NextToken());
+        p2cstr( myErrName );
+        wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
+                       libname.c_str(),
+                       (char*)myErrName );
+        m_handle = 0;
+    }

 
 

-        fullname << '/' << lib_name;
-        if ( wxFileExists(fullname) )
-        {
-            lib_name = fullname;
+#elif defined(__WXPM__) || defined(__EMX__)
+    char    err[256] = "";
+    DosLoadModule(err, sizeof(err), libname.c_str(), &m_handle);

 
 

-            // found the library
-            break;
-        }
+#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
+
+#if defined(__VMS) || defined(__DARWIN__)
+    m_handle = dlopen(libname.c_str(), 0);  // The second parameter is ignored
+#else // !__VMS  && !__DARWIN__
+    int rtldFlags = 0;
+
+    if ( flags & wxDL_LAZY )
+    {
+        wxASSERT_MSG( (flags & wxDL_NOW) == 0,
+                      _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") );
+#ifdef RTLD_LAZY
+        rtldFlags |= RTLD_LAZY;
+#else
+        wxLogDebug(_T("wxDL_LAZY is not supported on this platform"));
+#endif
+    }
+    else if ( flags & wxDL_NOW )
+    {
+#ifdef RTLD_NOW
+        rtldFlags |= RTLD_NOW;
+#else
+        wxLogDebug(_T("wxDL_NOW is not supported on this platform"));
+#endif

     }
     }

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

 
 

-#endif // __UNIX__
+    if ( flags & wxDL_GLOBAL )
+    {
+#ifdef RTLD_GLOBAL
+        rtldFlags |= RTLD_GLOBAL;
+#else
+        wxLogDebug(_T("RTLD_GLOBAL is not supported on this platform."));
+#endif
+    }

 
 

-    wxDllType handle;
+    m_handle = dlopen(libname.fn_str(), rtldFlags);
+#endif  // __VMS || __DARWIN__ ?

 
 

-#if defined(__WXMAC__)
-    FSSpec myFSSpec ;
-    Ptr        myMainAddr ;
-    Str255     myErrName ;
+#elif defined(HAVE_SHL_LOAD)
+    int shlFlags = 0;

 
 

-    wxMacPathToFSSpec( lib_name , &myFSSpec ) ;
-    if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr ,
-                myErrName ) != noErr )
+    if( flags & wxDL_LAZY )

     {
     {

-        p2cstr( myErrName ) ;
-        wxASSERT_MSG( 1 , (char*)myErrName ) ;
-        return NULL ;
+        wxASSERT_MSG( (flags & wxDL_NOW) == 0,
+                      _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") );
+        shlFlags |= BIND_DEFERRED;

     }
     }

-#else // !Mac
-    handle = wxDllOpen(lib_name);
-#endif // OS
+    else if( flags & wxDL_NOW )
+    {
+        shlFlags |= BIND_IMMEDIATE;
+    }
+    m_handle = shl_load(libname.fn_str(), BIND_DEFERRED, 0);
+
+#elif defined(__WINDOWS__)
+    m_handle = ::LoadLibrary(libname.c_str());
+#else
+    #error  "runtime shared lib support not implemented on this platform"
+#endif

 
 

-    if ( !handle )
+    if ( m_handle == 0 )

     {
     {

-        wxLogSysError(_("Failed to load shared library '%s'"),
-                      lib_name.c_str());
+        wxString msg(_("Failed to load shared library '%s'"));
+#if defined(HAVE_DLERROR) && !defined(__EMX__)
+
+#if wxUSE_UNICODE
+        wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() );
+        const wxChar *err = buffer;
+#else
+        const wxChar *err = dlerror();
+#endif

 
 

-        return NULL;
+        if( err )
+            wxLogError( msg, err );
+#else
+        wxLogSysError( msg, libname.c_str() );
+#endif

     }
 
     }
 

-    lib = new wxLibrary(handle);
+    return IsLoaded();
+}
+
+void wxDynamicLibrary::Unload()
+{
+    if( IsLoaded() )
+    {
+#if defined(__WXPM__) || defined(__EMX__)
+        DosFreeModule( m_handle );
+#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
+        dlclose( m_handle );
+#elif defined(HAVE_SHL_LOAD)
+        shl_unload( m_handle );
+#elif defined(__WINDOWS__)
+        ::FreeLibrary( m_handle );
+#elif defined(__WXMAC__) && !defined(__DARWIN__)
+        CloseConnection( (CFragConnectionID*) &m_handle );
+#else
+#error  "runtime shared lib support not implemented"
+#endif
+        m_handle = 0;
+    }
+}
+
+void *wxDynamicLibrary::GetSymbol(const wxString &name, bool *success) const
+{
+    wxCHECK_MSG( IsLoaded(), NULL,
+                 _T("Can't load symbol from unloaded library") );
+
+    bool     failed = FALSE;
+    void    *symbol = 0;
+
+#if defined(__WXMAC__) && !defined(__DARWIN__)
+    Ptr                 symAddress;
+    CFragSymbolClass    symClass;
+    Str255              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(__WXPM__) || defined(__EMX__)
+    DosQueryProcAddr( m_handle, 1L, name.c_str(), (PFN*)symbol );
+
+#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
+    symbol = dlsym( m_handle, name.fn_str() );
+
+#elif defined(HAVE_SHL_LOAD)
+    // use local variable since shl_findsym modifies the handle argument
+    // to indicate where the symbol was found (GD)
+    wxDllType the_handle = m_handle;
+    if( shl_findsym( &the_handle, name.fn_str(), TYPE_UNDEFINED, &symbol ) != 0 )
+        symbol = 0;
+
+#elif defined(__WINDOWS__)
+    symbol = (void*) ::GetProcAddress( m_handle, name.mb_str() );

 
 

-    wxClassInfo::sm_first = old_sm_first;
+#else
+#error  "runtime shared lib support not implemented"
+#endif
+
+    if ( !symbol )
+    {
+#if defined(HAVE_DLERROR) && !defined(__EMX__)
+
+#if wxUSE_UNICODE
+        wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() );
+        const wxChar *err = buffer;
+#else
+        const wxChar *err = dlerror();
+#endif

 
 

-    m_loaded.Append(name.GetData(), lib);
+        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 lib;
+    return symbol;

 }
 }

+    

 
 

-wxObject *wxLibraries::CreateObject(const wxString& path)
+/*static*/
+wxString wxDynamicLibrary::CanonicalizeName(const wxString& name,
+                                            wxDynamicLibraryCategory cat)

 {
 {

-    wxNode *node = m_loaded.First();
-    wxObject *obj;
+#ifdef __UNIX__
+    if ( cat == wxDL_MODULE )
+        return name + GetDllExt();
+    else
+        return wxString(_T("lib")) + name + GetDllExt();
+#else
+    return name + GetDllExt();
+#endif
+}

 
 

-    while (node) {
-        obj = ((wxLibrary *)node->Data())->CreateObject(path);
-        if (obj)
-            return obj;
+/*static*/
+wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
+                                                  wxPluginCategory cat)
+{
+    wxString suffix;
+    if ( cat == wxDL_PLUGIN_GUI )
+    {
+        suffix = wxString::FromAscii(
+#if defined(__WXMSW__)
+                "msw"
+#elif defined(__WXGTK__)
+                "gtk"
+#elif defined(__WXMGL__)
+                "mgl"
+#elif defined(__WXMOTIF__)
+                "motif"
+#elif defined(__WXOS2__)
+                "pm"
+#elif defined(__WXX11__)
+                "x11"
+#elif defined(__WXMAC__)
+                "mac"
+#elif defined(__WXCOCOA__)
+                "cocoa"
+#endif
+       );

 
 

-        node = node->Next();
+#ifdef __WXUNIVERSAL__
+        suffix << _T("univ");
+#endif

     }
     }

-    return NULL;
+#if wxUSE_UNICODE
+    suffix << _T('u');
+#endif
+#ifdef __WXDEBUG__
+    suffix << _T('d');
+#endif
+
+    if ( !suffix.empty() )
+        suffix = wxString(_T("_")) + suffix;
+
+#ifdef __UNIX__
+    #if (wxMINOR_VERSION % 2) == 0
+        #define wxDLLVER(x,y,z) "-" #x "." #y
+    #else
+        #define wxDLLVER(x,y,z) "-" #x "." #y "." #z
+    #endif
+#else
+    #if (wxMINOR_VERSION % 2) == 0
+        #define wxDLLVER(x,y,z) #x #y
+    #else
+        #define wxDLLVER(x,y,z) #x #y #z
+    #endif
+#endif
+    suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
+                                           wxRELEASE_NUMBER));
+#undef wxDLLVER
+
+    return CanonicalizeName(name + suffix, wxDL_MODULE);
+}
+    
+/*static*/
+wxString wxDynamicLibrary::GetPluginsDirectory()
+{
+#ifdef __UNIX__
+    wxString format = wxGetInstallPrefix();
+    format << wxFILE_SEP_PATH
+           << wxT("lib") << wxFILE_SEP_PATH
+           << wxT("wx") << wxFILE_SEP_PATH
+           << wxT("%i.%i");
+    wxString dir;
+    dir.Printf(format.c_str(), wxMAJOR_VERSION, wxMINOR_VERSION);
+    return dir;
+#else
+    return wxEmptyString;
+#endif

 }
 
 }
 

+

 #endif // wxUSE_DYNLIB_CLASS
 #endif // wxUSE_DYNLIB_CLASS