Cleanup

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

diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp
index 7e2f336baf90cc912c04552dcd6ea74eb978b132..023ff4fe2a3308cd9e61c6ad6f4722c984d8fe37 100644 (file)
--- a/src/common/dynlib.cpp
+++ b/src/common/dynlib.cpp
@@ -6,239 +6,514 @@
 // 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

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "dynlib.h"
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+#   pragma implementation "dynlib.h"

 #endif
 
 #endif
 

-#include <wx/dynlib.h>
-#include <wx/filefn.h>
-#include <wx/list.h>
-#include <wx/string.h>
+#include  "wx/wxprec.h"

 
 

-// ---------------------------------------------------------------------------
-// System dependent include
-// ---------------------------------------------------------------------------
+#ifdef __BORLANDC__
+  #pragma hdrstop
+#endif
+
+#if wxUSE_DYNLIB_CLASS

 
 

-#ifdef __UNIX__ 
-#include <dlfcn.h>
+#if defined(__WINDOWS__)
+    #include "wx/msw/private.h"

 #endif
 
 #endif
 

-#ifdef __WINDOWS__
-#include <windows.h>
+#include "wx/dynlib.h"
+#include "wx/filefn.h"
+#include "wx/intl.h"
+#include "wx/log.h"
+#include "wx/utils.h"
+#include "wx/filename.h"        // for SplitPath()
+#include "wx/app.h"
+#include "wx/apptrait.h"
+
+#if defined(__WXMAC__)
+    #include "wx/mac/private.h"

 #endif
 
 #endif
 

-// ---------------------------------------------------------------------------
-// Global variables
-// ---------------------------------------------------------------------------

 
 

-wxLibraries wxTheLibraries;
+// ============================================================================
+// 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(void *handle)
-{
-  typedef wxClassLibrary *(*t_get_list)(void);
-  t_get_list get_list;
+/* 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*.
+ */
+
+#include <stdio.h>
+#include <mach-o/dyld.h>

 
 

-  m_handle = handle;
+static char dl_last_error[1024];

 
 

-  get_list = (t_get_list)GetSymbol("GetClassList");
-  m_liblist = (*get_list)();
+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);

 }
 
 }
 

-wxLibrary::~wxLibrary()
+const char *dlerror()

 {
 {

-  if (m_handle) {
-    typedef void (*t_free_list)(wxClassLibrary *);
-    t_free_list free_list;
+    return dl_last_error;
+}

 
 

-    free_list = (t_free_list) GetSymbol("FreeClassList");
-    if (free_list != NULL)
-      free_list(m_liblist);
+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
     else

-      delete m_liblist;
+    {
+       // 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);
+    }

 
 

-#ifdef __UNIX__
-    dlclose(m_handle);
-#endif
-#ifdef __WINDOWS__
-    FreeLibrary((HMODULE)m_handle);
-#endif
-  }
+    return handle;

 }
 
 }
 

-wxObject *wxLibrary::CreateObject(const wxString& name)
+int dlclose(void *handle)

 {
 {

-  return m_liblist->CreateObject(name);
+    NSUnLinkModule( handle, NSUNLINKMODULE_OPTION_NONE);
+    return 0;

 }
 
 }
 

-void *wxLibrary::GetSymbol(const wxString& symbname)
+void *dlsym(void *handle, const char *symbol)

 {
 {

-#ifdef __UNIX__
-  return dlsym(m_handle, WXSTRINGCAST symbname);
-#endif
-#ifdef __WINDOWS__
-  return GetProcAddress(m_handle, WXSTRINGCAST symbname);
-#endif
-  return NULL;
+    void *addr;
+    
+    NSSymbol nsSymbol = NSLookupSymbolInModule( handle , symbol ) ;
+
+    if ( nsSymbol) 
+    {
+           addr = NSAddressOfSymbol(nsSymbol);
+    }
+    else 
+    {
+           addr = NULL;
+    }
+    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(__WXMAC__) && !defined(__DARWIN__)
+    const wxChar *wxDynamicLibrary::ms_dllext = _T("");
+#elif defined(__UNIX__)
+    #if defined(__HPUX__)
+        const wxChar *wxDynamicLibrary::ms_dllext = _T(".sl");
+    #elif defined(__DARWIN__)
+        const wxChar *wxDynamicLibrary::ms_dllext = _T(".dylib");
+    #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."));
+
+    // 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();
+        }
+    }

 
 

-  while (node) {
-    wxLibrary *lib = (wxLibrary *)node->Data();
-    delete lib;
+    // 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 )
+    {
+        p2cstr( myErrName );
+        wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
+                       libname.c_str(),
+                       (char*)myErrName );
+        m_handle = 0;
+    }

 
 

-    node = node->Next();
-  }
-}
+#elif defined(__WXPM__) || defined(__EMX__)
+    char    err[256] = "";
+    DosLoadModule(err, sizeof(err), libname.c_str(), &m_handle);
+
+#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
+
+#if defined(__VMS) || defined(__DARWIN__)
+    m_handle = dlopen(libname.fn_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
+    }

 
 

-wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
-{
-  wxString lib_name = name;
-  wxNode *node;
-  wxLibrary *lib;
+    if ( flags & wxDL_GLOBAL )
+    {
+#ifdef RTLD_GLOBAL
+        rtldFlags |= RTLD_GLOBAL;
+#else
+        wxLogDebug(_T("RTLD_GLOBAL is not supported on this platform."));
+#endif
+    }

 
 

-  if ( (node = m_loaded.Find(name.GetData())) )
-    return ((wxLibrary *)node->Data());
+    m_handle = dlopen(libname.fn_str(), rtldFlags);
+#endif  // __VMS || __DARWIN__ ?

 
 

-#ifdef __UNIX__
-  lib_name.Prepend("lib");
-  lib_name += ".so";
+#elif defined(HAVE_SHL_LOAD)
+    int shlFlags = 0;
+
+    if( flags & wxDL_LAZY )
+    {
+        wxASSERT_MSG( (flags & wxDL_NOW) == 0,
+                      _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") );
+        shlFlags |= BIND_DEFERRED;
+    }
+    else if( flags & wxDL_NOW )
+    {
+        shlFlags |= BIND_IMMEDIATE;
+    }
+    m_handle = shl_load(libname.fn_str(), BIND_DEFERRED, 0);

 
 

-  printf("lib_name = %s\n", WXSTRINGCAST lib_name);
+#elif defined(__WINDOWS__)
+    m_handle = ::LoadLibrary(libname.c_str());
+#else
+    #error  "runtime shared lib support not implemented on this platform"
+#endif

 
 

-  void *handle = dlopen(WXSTRINGCAST lib_name, RTLD_LAZY);
+    if ( m_handle == 0 )
+    {
+        wxString msg(_("Failed to load shared library '%s'"));
+#if defined(HAVE_DLERROR) && !defined(__EMX__)

 
 

-  if (!handle)
-    return NULL;
+#if wxUSE_UNICODE
+        wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() );
+        const wxChar *err = buffer;
+#else
+        const wxChar *err = dlerror();

 #endif
 #endif

-#ifdef __WINDOWS__
-  lib_name += ".dll";

 
 

-  HMODULE handle = LoadLibrary(lib_name);
-  if (!handle)
-    return NULL;
+        if( err )
+            wxLogError( msg, err );
+#else
+        wxLogSysError( msg, libname.c_str() );

 #endif
 #endif

-  lib = new wxLibrary((void *)handle);
+    }

 
 

-  m_loaded.Append(name.GetData(), lib);
-  return lib;
+    return IsLoaded();

 }
 
 }
 

-wxObject *wxLibraries::CreateObject(const wxString& path)
+/* static */
+void wxDynamicLibrary::Unload(wxDllType handle)

 {
 {

-  wxNode *node = m_loaded.First();
-  wxObject *obj;
-
-  while (node) {
-    obj = ((wxLibrary *)node->Data())->CreateObject(path);
-    if (obj) 
-      return obj;
-
-    node = node->Next();
-  }
-  return NULL;
+#if defined(__WXPM__) || defined(__EMX__)
+    DosFreeModule( handle );
+#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
+    dlclose( handle );
+#elif defined(HAVE_SHL_LOAD)
+    shl_unload( handle );
+#elif defined(__WINDOWS__)
+    ::FreeLibrary( handle );
+#elif defined(__WXMAC__) && !defined(__DARWIN__)
+    CloseConnection( (CFragConnectionID*) &handle );
+#else
+    #error  "runtime shared lib support not implemented"
+#endif

 }
 
 }
 

-// ---------------------------------------------------------------------------
-// wxClassLibrary (this class is used to access the internal class)
-// ---------------------------------------------------------------------------
-
-wxClassLibrary::wxClassLibrary(void)
+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;
+
+    wxUnusedVar(symbol);
+#if defined(__WXMAC__) && !defined(__DARWIN__)
+    Ptr                 symAddress;
+    CFragSymbolClass    symClass;
+    Str255              symName;
+#if TARGET_CARBON
+    c2pstrcpy( (StringPtr) symName, name.fn_str() );
+#else
+    strcpy( (char *)symName, name.fn_str() );
+    c2pstr( (char *)symName );
+#endif
+    if( FindSymbol( m_handle, 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__)
+#ifdef __WXWINCE__
+    symbol = (void*) ::GetProcAddress( m_handle, name );
+#else
+    symbol = (void*) ::GetProcAddress( m_handle, name.mb_str() );
+#endif

 
 

-wxClassLibrary::~wxClassLibrary(void)
-{
-  uint i;
+#else
+#error  "runtime shared lib support not implemented"
+#endif

 
 

-  for (i=0;i<m_list.Count();i++)
-    delete (m_list[i]);
-}
+    if ( !symbol )
+    {
+#if defined(HAVE_DLERROR) && !defined(__EMX__)

 
 

-void wxClassLibrary::RegisterClass(wxClassInfo *class_info,
-                                   const wxString& path)
-{
-  wxClassLibInfo *info = new wxClassLibInfo;
+#if wxUSE_UNICODE
+        wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() );
+        const wxChar *err = buffer;
+#else
+        const wxChar *err = dlerror();
+#endif

 
 

-  info->class_info = class_info;
-  info->path = path;
-  m_list.Add(info);
+        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;

 }
 }

+    

 
 

-void wxClassLibrary::UnregisterClass(wxClassInfo *class_info)
+/*static*/
+wxString
+wxDynamicLibrary::CanonicalizeName(const wxString& name,
+                                   wxDynamicLibraryCategory
+#ifdef __UNIX__
+                                        cat
+#else // !__UNIX__
+                                        WXUNUSED(cat)
+#endif // __UNIX__/!__UNIX__
+                                   )

 {
 {

-  uint i = 0;
+    wxString nameCanonic;

 
 

-  while (i < m_list.Count()) {
-    if (m_list[i]->class_info == class_info) {
-      delete (m_list[i]);
-      m_list.Remove(i);
-      return;
+    // under Unix the library names usually start with "lib" prefix, add it
+#ifdef __UNIX__
+    switch ( cat )
+    {
+        default:
+            wxFAIL_MSG( _T("unknown wxDynamicLibraryCategory value") );
+            // fall through
+
+        case wxDL_MODULE:
+            // don't do anything for modules, their names are arbitrary
+            break;
+
+        case wxDL_LIBRARY:
+            // library names should start with "lib" under Unix
+            nameCanonic = _T("lib");
+            break;

     }
     }

-    i++;
-  }
-}
+#endif // __UNIX__

 
 

-bool wxClassLibrary::CreateObjects(const wxString& path,
-                                   wxArrayClassInfo& objs)
-{
-  wxClassLibInfo *info;
-  uint i = 0;
-
-  while (i < m_list.Count()) {
-    info = m_list[i];
-    if (wxMatchWild(path, info->path))
-      objs.Add(info->class_info);
-    i++;
-  }
-  return (i > 0);
+    nameCanonic << name << GetDllExt();
+    return nameCanonic;

 }
 
 }
 

-bool wxClassLibrary::FetchInfos(const wxString& path,
-                                wxArrayClassLibInfo& infos)
+/*static*/
+wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
+                                                  wxPluginCategory cat)

 {
 {

-  wxClassLibInfo *info;
-  uint i = 0;
-
-  while (i < m_list.Count()) {
-    info = m_list[i];
-    if (wxMatchWild(path, info->path)) {
-      wxClassLibInfo *inf = new wxClassLibInfo;
-      *inf = *info;
-      infos.Add(inf);
-    }
-    i++;
-  }
-  return (i > 0);
-}
+    wxString suffix;
+    if ( cat == wxDL_PLUGIN_GUI )
+    {
+        wxAppTraits *traits = wxAppConsole::GetInstance() ?
+                              wxAppConsole::GetInstance()->GetTraits() : NULL;
+        wxASSERT_MSG( traits, 
+               _("can't query for GUI plugins name in console applications") );
+        suffix = traits->GetToolkitInfo().shortName;
+    }
+#if wxUSE_UNICODE
+    suffix << _T('u');
+#endif
+#ifdef __WXDEBUG__
+    suffix << _T('d');
+#endif
+
+    if ( !suffix.empty() )
+        suffix = wxString(_T("_")) + suffix;
+
+#define WXSTRINGIZE(x)  #x
+#ifdef __UNIX__
+    #if (wxMINOR_VERSION % 2) == 0
+        #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y)
+    #else
+        #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y) "." WXSTRINGIZE(z)
+    #endif
+#else
+    #if (wxMINOR_VERSION % 2) == 0
+        #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y)
+    #else
+        #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y) WXSTRINGIZE(z)
+    #endif
+#endif

 
 

-wxObject *wxClassLibrary::CreateObject(const wxString& path)
+    suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
+                                           wxRELEASE_NUMBER));
+#undef wxDLLVER
+#undef WXSTRINGIZE
+
+#ifdef __WINDOWS__
+    // Add compiler identification:
+    #if defined(__GNUG__)
+        suffix << _T("_gcc");
+    #elif defined(__VISUALC__)
+        suffix << _T("_vc");
+    #elif defined(__WATCOMC__)
+        suffix << _T("_wat");
+    #elif defined(__BORLANDC__)
+        suffix << _T("_bcc");
+    #endif
+#endif
+
+    return CanonicalizeName(name + suffix, wxDL_MODULE);
+}
+    
+/*static*/
+wxString wxDynamicLibrary::GetPluginsDirectory()

 {
 {

-  wxClassLibInfo *info;
-  uint i = 0;
-
-  while (i < m_list.Count()) {
-    info = m_list[i];
-    if (wxMatchWild(path, info->path))
-      return info->class_info->CreateObject();
-    i++;
-  }
-  return NULL;
+#ifdef __UNIX__
+    wxString format = wxGetInstallPrefix();
+    wxString dir;
+    format << wxFILE_SEP_PATH
+           << wxT("lib") << wxFILE_SEP_PATH
+           << wxT("wx") << wxFILE_SEP_PATH
+#if (wxMINOR_VERSION % 2) == 0
+           << wxT("%i.%i");
+    dir.Printf(format.c_str(), wxMAJOR_VERSION, wxMINOR_VERSION);
+#else
+           << wxT("%i.%i.%i");
+    dir.Printf(format.c_str(),
+               wxMAJOR_VERSION, wxMINOR_VERSION, wxRELEASE_NUMBER);
+#endif
+    return dir;
+
+#else // ! __UNIX__
+    return wxEmptyString;
+#endif

 }
 }

+
+
+#endif // wxUSE_DYNLIB_CLASS