1. wxWindow::IsTopLevel() added and documented

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

diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp
index 6b8bf78e38f06d4cbd4e15fbae7ad8120acd3db8..b4a60768fb10eb2357b00c048ecfbae07d6bf25b 100644 (file)
--- a/src/common/dynlib.cpp
+++ b/src/common/dynlib.cpp
@@ -9,8 +9,16 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+

 #ifdef __GNUG__
 #ifdef __GNUG__

-#pragma implementation "dynlib.h"
+    #pragma implementation "dynlib.h"

 #endif
 
 #include  "wx/wxprec.h"
 #endif
 
 #include  "wx/wxprec.h"


@@ -19,120 +27,168 @@
   #pragma hdrstop
 #endif  //__BORLANDC__
 
   #pragma hdrstop
 #endif  //__BORLANDC__
 

-#ifndef WX_PRECOMP
-#endif //WX_PRECOMP
-
-#include <wx/dynlib.h>
-#include <wx/filefn.h>
-#include <wx/list.h>
-#include <wx/string.h>
+#if wxUSE_DYNLIB_CLASS
+
+#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.fn_str(), RTLD_LAZY)
+    #define wxDllGetSymbol(handle, name)  dlsym(handle, name.mb_str())
+    #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 wxString& name)
+    {
+        void *sym;
+        if ( shl_findsym(&handle, name.mb_str(), TYPE_UNDEFINED, &sym) == 0 )
+            return sym;
+        else
+            return (void *)0;
+    }
+#elif defined(__WINDOWS__)
+    #include <windows.h>
+
+    // using LoadLibraryEx under Win32 to avoid name clash with LoadLibrary
+    #ifdef __WIN32__
+        #define wxDllOpen(lib)                  ::LoadLibraryEx(lib, 0, 0)
+    #else   // Win16
+        #define wxDllOpen(lib)                  ::LoadLibrary(lib)
+    #endif  // Win32/16
+    #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

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

-// System dependent include
+// Global variables

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

-#if defined(__UNIX__)
-#include <dlfcn.h>
-#endif
+wxLibraries wxTheLibraries;

 
 

-#ifdef __WINDOWS__
-#include <windows.h>
-#endif
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------

 
 

-#ifdef LoadLibrary
-#undef LoadLibrary
+// 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";

 #endif
 
 #endif
 

-// ---------------------------------------------------------------------------
-// Global variables
-// ---------------------------------------------------------------------------
+    return fullname;
+}

 
 

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

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

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

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

-wxLibrary::wxLibrary(void *handle)
+wxLibrary::wxLibrary(wxDllType handle)

 {
 {

-  typedef wxClassInfo *(*t_get_first)(void);
-  t_get_first get_first;
+    typedef wxClassInfo *(*t_get_first)(void);
+    t_get_first get_first;

 
 

-  m_handle = handle;
-  m_destroy = TRUE;
+    m_handle = handle;

 
 

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

-  if (m_handle && m_destroy) {
-#if defined(__UNIX__)
-    dlclose(m_handle);
-#endif
-#ifdef __WINDOWS__
-    FreeLibrary((HMODULE)m_handle);
-#endif
-  }
+    if ( m_handle )
+    {
+        wxDllClose(m_handle);
+    }

 }
 
 wxObject *wxLibrary::CreateObject(const wxString& name)
 {
 }
 
 wxObject *wxLibrary::CreateObject(const wxString& name)
 {

-  wxClassInfo *info = (wxClassInfo *)classTable.Get(name);
+    wxClassInfo *info = (wxClassInfo *)classTable.Get(name);

 
 

-  if (!info)
-    return NULL;
+    if (!info)
+        return NULL;

 
 

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

 }
 
 void wxLibrary::PrepareClasses(wxClassInfo *first)
 {
 }
 
 void wxLibrary::PrepareClasses(wxClassInfo *first)
 {

-  // Index all class infos by their class name
-  wxClassInfo *info = first;
-  while (info)
-  {
-    if (info->m_className)
-      classTable.Put(info->m_className, (wxObject *)info);
-    info = info->GetNext();
-  }
-
-  // Set base pointers for each wxClassInfo
-  info = first;
-  while (info)
-  {
-    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;
-  }
+    // Index all class infos by their class name
+    wxClassInfo *info = first;
+    while (info)
+    {
+        if (info->m_className)
+            classTable.Put(info->m_className, (wxObject *)info);
+        info = info->GetNext();
+    }
+
+    // Set base pointers for each wxClassInfo
+    info = first;
+    while (info)
+    {
+        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;
+    }

 }
 
 void *wxLibrary::GetSymbol(const wxString& symbname)
 {
 }
 
 void *wxLibrary::GetSymbol(const wxString& symbname)
 {

-#if defined(__UNIX__)
-  return dlsym(m_handle, WXSTRINGCAST symbname);
-#elif defined( __WINDOWS__ )
-  return GetProcAddress((HINSTANCE) m_handle, WXSTRINGCAST symbname);
-#elif defined( __WXMAC__ )
-  Ptr symAddress ;
-  CFragSymbolClass symClass ;
-  Str255       symName ;
-       
-  strcpy( (char*) symName , symbname ) ;
-  c2pstr( (char*) symName ) ;
-       
-  if ( FindSymbol( (CFragConnectionID) m_handle , symName , &symAddress , &symClass ) == noErr )
-  {
-    return symAddress ; 
-  }
+    void *symbol = NULL;    // return value
+
+#if defined( __WXMAC__ )
+    Ptr symAddress ;
+    CFragSymbolClass symClass ;
+    Str255     symName ;
+
+    strcpy( (char*) symName , symbname ) ;
+    c2pstr( (char*) symName ) ;
+
+    if ( FindSymbol( m_handle , symName , &symAddress , &symClass ) == noErr )
+    {
+        symbol = (void *)symAddress ; 
+    }
+#else
+    symbol = wxDllGetSymbol(m_handle, symbname);

 #endif
 #endif

-  return NULL;
+
+    if ( !symbol )
+    {
+        wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
+                      symbname.c_str());
+    }
+
+    return symbol;

 }
 
 // ---------------------------------------------------------------------------
 }
 
 // ---------------------------------------------------------------------------


@@ -145,93 +201,104 @@ wxLibraries::wxLibraries()
 
 wxLibraries::~wxLibraries()
 {
 
 wxLibraries::~wxLibraries()
 {

-  wxNode *node = m_loaded.First();
+    wxNode *node = m_loaded.First();

 
 

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

 
 

-    node = node->Next();
-  }
+        node = node->Next();
+    }

 }
 
 wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
 {
 }
 
 wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
 {

-  wxString lib_name = name;
-  wxNode *node;
-  wxLibrary *lib;
-  wxClassInfo *old_sm_first;
-
-  if ( (node = m_loaded.Find(name.GetData())) )
-    return ((wxLibrary *)node->Data());
+    wxNode *node;
+    wxLibrary *lib;
+    wxClassInfo *old_sm_first;

 
 

-  // If DLL shares data, this is necessary.
-  old_sm_first = wxClassInfo::sm_first;
-  wxClassInfo::sm_first = NULL;
+    if ( (node = m_loaded.Find(name.GetData())) )
+        return ((wxLibrary *)node->Data());

 
 

-#if defined(__UNIX__)
-  lib_name.Prepend("./lib");
-  lib_name += ".so";
+    // If DLL shares data, this is necessary.
+    old_sm_first = wxClassInfo::sm_first;
+    wxClassInfo::sm_first = NULL;

 
 

-  printf("lib_name = %s\n", WXSTRINGCAST lib_name);
+    wxString lib_name = ConstructLibraryName(name);

 
 

-  void *handle = dlopen(WXSTRINGCAST lib_name, RTLD_LAZY);
-
-  printf("error = %s\n", dlerror());
-
-  if (!handle)
-    return NULL;
-#elif defined(__WINDOWS__)
-  lib_name += ".dll";
-
-#ifdef UNICODE
-  HMODULE handle = LoadLibraryW(lib_name);
-#else
-#ifdef __WIN16__
-  HMODULE handle = ::LoadLibrary(lib_name);
-#else
-  HMODULE handle = LoadLibraryA(lib_name);
-#endif
-#endif
-  if (!handle)
-    return NULL;
-#elif defined(__WXMAC__)
-  FSSpec myFSSpec ;
-  CFragConnectionID handle ;
-  Ptr  myMainAddr ;
-  Str255       myErrName ;
-       
-  wxMacPathToFSSpec( lib_name , &myFSSpec ) ;
-  if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr ,
-    myErrName ) != noErr )
-  {
-    p2cstr( myErrName ) ;
-    wxASSERT_MSG( 1 , (char*)myErrName ) ;
-       return NULL ;
-  }
-#else
-  return NULL;
-#endif
-
-  lib = new wxLibrary((void *)handle);
-
-  wxClassInfo::sm_first = old_sm_first;
-
-  m_loaded.Append(name.GetData(), lib);
-  return lib;
+#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, _T(':'));
+    while ( tokenizer.HasMoreToken() )
+    {
+        wxString fullname(tokenizer.NextToken());
+
+        fullname << '/' << lib_name;
+        if ( wxFileExists(fullname) )
+        {
+            lib_name = fullname;
+
+            // found the library
+            break;
+        }
+    }
+    //else: not found in the path, leave the name as is (secutiry risk?)
+
+#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 )
+    {
+        p2cstr( myErrName ) ;
+        wxASSERT_MSG( 1 , (char*)myErrName ) ;
+        return NULL ;
+    }
+#else // !Mac
+    handle = wxDllOpen(lib_name);
+#endif // OS
+
+    if ( !handle )
+    {
+        wxLogSysError(_("Failed to load shared library '%s'"),
+                      lib_name.c_str());
+
+        return NULL;
+    }
+
+    lib = new wxLibrary(handle);
+
+    wxClassInfo::sm_first = old_sm_first;
+
+    m_loaded.Append(name.GetData(), lib);
+
+    return lib;

 }
 
 wxObject *wxLibraries::CreateObject(const wxString& path)
 {
 }
 
 wxObject *wxLibraries::CreateObject(const wxString& path)
 {

-  wxNode *node = m_loaded.First();
-  wxObject *obj;
+    wxNode *node = m_loaded.First();
+    wxObject *obj;

 
 

-  while (node) {
-    obj = ((wxLibrary *)node->Data())->CreateObject(path);
-    if (obj)
-      return obj;
+    while (node) {
+        obj = ((wxLibrary *)node->Data())->CreateObject(path);
+        if (obj)
+            return obj;

 
 

-    node = node->Next();
-  }
-  return NULL;
+        node = node->Next();
+    }
+    return NULL;

 }
 }

+
+#endif // wxUSE_DYNLIB_CLASS