don't test for things which bakefile already tests for (STRIP, RANLIB, INSTALL, WINDR...

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

diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp
index 9c5a7771099496dcc9bfce8429cf3e37e1702e8a..ff9c14648d5397bd870cb8a6d9355f162eb0ddf5 100644 (file)
--- a/src/common/dynlib.cpp
+++ b/src/common/dynlib.cpp
@@ -1,191 +1,323 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        dynlib.cpp
+// Name:        src/common/dynlib.cpp

 // Purpose:     Dynamic library management
 // Author:      Guilhem Lavaux
 // Modified by:
 // Created:     20/07/98
 // RCS-ID:      $Id$
 // Purpose:     Dynamic library management
 // Author:      Guilhem Lavaux
 // Modified by:
 // Created:     20/07/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Guilhem Lavaux
-// Licence:     wxWindows license
+// Copyright:   (c) 1998 Guilhem Lavaux
+//                  2000-2005 Vadim Zeitlin
+// Licence:     wxWindows licence

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

-#ifdef __GNUG__
-#pragma implementation "dynlib.h"
-#endif
+//FIXME:  This class isn't really common at all, it should be moved into
+//        platform dependent files (already done for Windows and Unix)

 
 

-#include <wx/dynlib.h>
-#include <wx/filefn.h>
-#include <wx/list.h>
-#include <wx/string.h>
+// ============================================================================
+// declarations
+// ============================================================================

 
 

-// ---------------------------------------------------------------------------
-// System dependent include
-// ---------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------

 
 

-#ifdef __UNIX__ 
-#include <dlfcn.h>
-#endif
+#include  "wx/wxprec.h"

 
 

-#ifdef __WINDOWS__
-#include <windows.h>
+#ifdef __BORLANDC__
+    #pragma hdrstop

 #endif
 
 #endif
 

-#ifdef LoadLibrary
-#undef LoadLibrary
+#if wxUSE_DYNLIB_CLASS
+
+#include "wx/dynlib.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/utils.h"
+#endif //WX_PRECOMP
+
+#include "wx/filefn.h"
+#include "wx/filename.h"        // for SplitPath()
+#include "wx/platinfo.h"
+
+#include "wx/arrimpl.cpp"
+
+#if defined(__WXMAC__)
+    #include "wx/mac/private.h"

 #endif
 
 #endif
 

-// ---------------------------------------------------------------------------
-// Global variables
-// ---------------------------------------------------------------------------
+WX_DEFINE_USER_EXPORTED_OBJARRAY(wxDynamicLibraryDetailsArray)

 
 

-wxLibraries wxTheLibraries;
+// ============================================================================
+// implementation
+// ============================================================================

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

-// wxLibrary (one instance per dynamic library
+// wxDynamicLibrary

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

-wxLibrary::wxLibrary(void *handle)
-{
-  typedef wxClassInfo **(*t_get_first)(void);
-  t_get_first get_first;
+#if defined(__WXPM__) || defined(__EMX__)
+    const wxString wxDynamicLibrary::ms_dllext(_T(".dll"));
+#elif defined(__WXMAC__) && !defined(__DARWIN__)
+    const wxString wxDynamicLibrary::ms_dllext; // empty string
+#endif

 
 

-  m_handle = handle;
-  m_destroy = TRUE;
+// for MSW/Unix it is defined in platform-specific file
+#if !(defined(__WXMSW__) || defined(__UNIX__)) || defined(__EMX__)

 
 

-  // 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());
-}
-
-wxLibrary::~wxLibrary()
+wxDllType wxDynamicLibrary::GetProgramHandle()

 {
 {

-  if (m_handle && m_destroy) {
-#ifdef __UNIX__
-    dlclose(m_handle);
-#endif
-#ifdef __WINDOWS__
-    FreeLibrary((HMODULE)m_handle);
-#endif
-  }
+   wxFAIL_MSG( wxT("GetProgramHandle() is not implemented under this platform"));
+   return 0;

 }
 
 }
 

-wxObject *wxLibrary::CreateObject(const wxString& name)
+#endif // __WXMSW__ || __UNIX__
+
+
+bool wxDynamicLibrary::Load(const wxString& libnameOrig, int flags)

 {
 {

-  wxClassInfo *info = (wxClassInfo *)classTable.Get(name);
+    wxASSERT_MSG(m_handle == 0, _T("Library already loaded."));
+
+    // add the proper extension for the DLL ourselves unless told not to
+    wxString libname = libnameOrig;
+    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();
+        }
+    }
+
+    // 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 )
+    {
+        wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
+                       libname.c_str(),
+                       wxMacMakeStringFromPascal( myErrName ).c_str() );
+        m_handle = 0;
+    }
+
+#elif defined(__WXPM__) || defined(__EMX__)
+    char err[256] = "";
+    DosLoadModule(err, sizeof(err), libname.c_str(), &m_handle);
+#else // this should be the only remaining branch eventually
+    m_handle = RawLoad(libname, flags);
+#endif

 
 

-  if (!info)
-    return NULL;
+    if ( m_handle == 0 )
+    {
+#ifdef wxHAVE_DYNLIB_ERROR
+        Error();
+#else
+        wxLogSysError(_("Failed to load shared library '%s'"), libname.c_str());
+#endif
+    }

 
 

-  return info->CreateObject();
+    return IsLoaded();

 }
 
 }
 

-void wxLibrary::PrepareClasses(wxClassInfo **first)
+// for MSW and Unix this is implemented in the platform-specific file
+//
+// TODO: move the rest to os2/dlpm.cpp and mac/dlmac.cpp!
+#if (!defined(__WXMSW__) && !defined(__UNIX__)) || defined(__EMX__)
+
+/* static */
+void wxDynamicLibrary::Unload(wxDllType handle)

 {
 {

-  // Index all class infos by their class name
-  wxClassInfo *info = *first;
-  while (info)
-  {
-    if (info->className)
-      classTable.Put(info->className, (wxObject *)info);
-    info = info->next;
-  }
-
-  // Set base pointers for each wxClassInfo
-  info = *first;
-  while (info)
-  {
-    if (info->GetBaseClassName1())
-      info->baseInfo1 = (wxClassInfo *)classTable.Get(info->GetBaseClassName1());
-    if (info->GetBaseClassName2())
-      info->baseInfo2 = (wxClassInfo *)classTable.Get(info->GetBaseClassName2());
-    info = info->next;
-  }
-  *first = NULL;
+#if defined(__OS2__) || defined(__EMX__)
+    DosFreeModule( handle );
+#elif defined(__WXMAC__) && !defined(__DARWIN__)
+    CloseConnection( (CFragConnectionID*) &handle );
+#else
+    #error  "runtime shared lib support not implemented"
+#endif

 }
 
 }
 

-void *wxLibrary::GetSymbol(const wxString& symbname)
+#endif // !(__WXMSW__ || __UNIX__)
+
+void *wxDynamicLibrary::DoGetSymbol(const wxString &name, bool *success) const

 {
 {

-#ifdef __UNIX__
-  return dlsym(m_handle, WXSTRINGCAST symbname);
+    wxCHECK_MSG( IsLoaded(), NULL,
+                 _T("Can't load symbol from unloaded library") );
+
+    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
 #endif

-#ifdef __WINDOWS__
-  return GetProcAddress(m_handle, WXSTRINGCAST symbname);
+    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 );
+#else
+    symbol = RawGetSymbol(m_handle, name);

 #endif
 #endif

-  return NULL;
-}

 
 

-// ---------------------------------------------------------------------------
-// wxLibraries (only one instance should normally exist)
-// ---------------------------------------------------------------------------
+    if ( success )
+        *success = symbol != NULL;

 
 

-wxLibraries::wxLibraries()
-{
+    return symbol;

 }
 
 }
 

-wxLibraries::~wxLibraries()
+void *wxDynamicLibrary::GetSymbol(const wxString& name, bool *success) const

 {
 {

-  wxNode *node = m_loaded.First();
+    void *symbol = DoGetSymbol(name, success);
+    if ( !symbol )
+    {
+#ifdef wxHAVE_DYNLIB_ERROR
+        Error();
+#else
+        wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
+                      name.c_str());
+#endif
+    }
+
+    return symbol;
+}

 
 

-  while (node) {
-    wxLibrary *lib = (wxLibrary *)node->Data();
-    delete lib;
+// ----------------------------------------------------------------------------
+// informational methods
+// ----------------------------------------------------------------------------

 
 

-    node = node->Next();
-  }
+/*static*/
+wxString
+wxDynamicLibrary::CanonicalizeName(const wxString& name,
+                                   wxDynamicLibraryCategory cat)
+{
+    wxString nameCanonic;
+
+    // under Unix the library names usually start with "lib" prefix, add it
+#if defined(__UNIX__) && !defined(__EMX__)
+    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;
+    }
+#else // !__UNIX__
+    wxUnusedVar(cat);
+#endif // __UNIX__/!__UNIX__
+
+    nameCanonic << name << GetDllExt();
+    return nameCanonic;

 }
 
 }
 

-wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
+/*static*/
+wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
+                                                  wxPluginCategory cat)

 {
 {

-  wxString lib_name = name;
-  wxNode *node;
-  wxLibrary *lib;
+    wxString suffix;
+    if ( cat == wxDL_PLUGIN_GUI )
+    {
+        suffix = wxPlatformInfo::Get().GetPortIdShortName();
+    }
+#if wxUSE_UNICODE
+    suffix << _T('u');
+#endif
+#ifdef __WXDEBUG__
+    suffix << _T('d');
+#endif

 
 

-  if ( (node = m_loaded.Find(name.GetData())) )
-    return ((wxLibrary *)node->Data());
+    if ( !suffix.empty() )
+        suffix = wxString(_T("_")) + suffix;

 
 

-#if defined(__UNIX__)
-  lib_name.Prepend("./lib");
-  lib_name += ".so";
+#define WXSTRINGIZE(x)  #x
+#if defined(__UNIX__) && !defined(__EMX__)
+    #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

 
 

-  printf("lib_name = %s\n", WXSTRINGCAST lib_name);
+    suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
+                                           wxRELEASE_NUMBER));
+#undef wxDLLVER
+#undef WXSTRINGIZE

 
 

-  void *handle = dlopen(WXSTRINGCAST lib_name, RTLD_LAZY);
+#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

 
 

-  if (!handle)
-    return NULL;
-#elif defined(__WINDOWS__)
-  lib_name += ".dll";
+    return CanonicalizeName(name + suffix, wxDL_MODULE);
+}

 
 

-#ifdef UNICODE
-  HMODULE handle = LoadLibraryW(lib_name);
-#else
-  HMODULE handle = LoadLibraryA(lib_name);
-#endif
-  if (!handle)
-    return NULL;
+/*static*/
+wxString wxDynamicLibrary::GetPluginsDirectory()
+{
+#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
 #else

-  return NULL;
+           << wxT("%i.%i.%i");
+    dir.Printf(format.c_str(),
+               wxMAJOR_VERSION, wxMINOR_VERSION, wxRELEASE_NUMBER);

 #endif
 #endif

+    return dir;

 
 

-  lib = new wxLibrary((void *)handle);
-
-  m_loaded.Append(name.GetData(), lib);
-  return lib;
+#else // ! __UNIX__
+    return wxEmptyString;
+#endif

 }
 
 }
 

-wxObject *wxLibraries::CreateObject(const wxString& path)
-{
-  wxNode *node = m_loaded.First();
-  wxObject *obj;
-
-  while (node) {
-    obj = ((wxLibrary *)node->Data())->CreateObject(path);
-    if (obj) 
-      return obj;

 
 

-    node = node->Next();
-  }
-  return NULL;
-}
+#endif // wxUSE_DYNLIB_CLASS