remove unnecessary class definitions and variables

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

diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp
index f90788fb174e606f10a00193dd7e598f1ae26ec4..d8ab264fb4a03c057259d18bebc5a110ec0755bf 100644 (file)
--- a/src/common/dynlib.cpp
+++ b/src/common/dynlib.cpp
@@ -1,14 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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

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

+//FIXME:  This class isn't really common at all, it should be moved into
+//        platform dependent files (already done for Windows and Unix)
+

 // ============================================================================
 // declarations
 // ============================================================================
 // ============================================================================
 // declarations
 // ============================================================================


@@ -17,416 +21,261 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-#   pragma implementation "dynlib.h"
-#endif
-

 #include  "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #include  "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-  #pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #if wxUSE_DYNLIB_CLASS
 
 #endif
 
 #if wxUSE_DYNLIB_CLASS
 

-#if defined(__WINDOWS__)
-    #include "wx/msw/private.h"
-#endif
-

 #include "wx/dynlib.h"
 #include "wx/dynlib.h"

-#include "wx/filefn.h"
-#include "wx/intl.h"
-#include "wx/log.h"
-#include "wx/tokenzr.h"

 
 

-// ----------------------------------------------------------------------------
-// conditional compilation
-// ----------------------------------------------------------------------------
+#ifndef WX_PRECOMP
+    #include "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/utils.h"
+#endif //WX_PRECOMP

 
 

-#if defined(__WXPM__) || defined(__EMX__)
-#  define INCL_DOS
-#  include <os2.h>
-#  define wxDllOpen(error, lib, handle)     DosLoadModule(error, sizeof(error), lib, &handle)
-#  define wxDllGetSymbol(handle, modaddr)   DosQueryProcAddr(handle, 1L, NULL, (PFN*)modaddr)
-#  define wxDllClose(handle)                DosFreeModule(handle)
-#elif defined(HAVE_DLOPEN)
-    // 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
-
-    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(__APPLE__) && defined(__UNIX__)
-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__
-#ifdef _UNICODE
-#      define wxDllOpen(lib)                  ::LoadLibraryExW(lib, 0, 0)
-#else
-#      define wxDllOpen(lib)                  ::LoadLibraryExA(lib, 0, 0)
-#endif
-#   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
+#include "wx/filefn.h"
+#include "wx/filename.h"        // for SplitPath()
+#include "wx/platinfo.h"

 
 

-// ---------------------------------------------------------------------------
-// Global variables
-// ---------------------------------------------------------------------------
+#include "wx/arrimpl.cpp"

 
 

-wxLibraries wxTheLibraries;
+WX_DEFINE_USER_EXPORTED_OBJARRAY(wxDynamicLibraryDetailsArray)

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

-// 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;
-    fullname << basename << wxDllLoader::GetDllExt();
-
-    return fullname;
-}
-

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

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

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

-wxLibrary::wxLibrary(wxDllType handle)
-{
-    typedef wxClassInfo *(*t_get_first)(void);
-    t_get_first get_first;
-
-    m_handle = handle;
+#if defined(__WXPM__) || defined(__EMX__)
+    const wxString wxDynamicLibrary::ms_dllext(wxT(".dll"));
+#endif

 
 

-    // 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());
-}
+// for MSW/Unix it is defined in platform-specific file
+#if !(defined(__WXMSW__) || defined(__UNIX__)) || defined(__EMX__)

 
 

-wxLibrary::~wxLibrary()
+wxDllType wxDynamicLibrary::GetProgramHandle()

 {
 {

-    if ( m_handle )
-    {
-        wxDllClose(m_handle);
-    }
+   wxFAIL_MSG( wxT("GetProgramHandle() is not implemented under this platform"));
+   return 0;

 }
 
 }
 

-wxObject *wxLibrary::CreateObject(const wxString& name)
-{
-    wxClassInfo *info = (wxClassInfo *)classTable.Get(name);
-
-    if (!info)
-        return NULL;
+#endif // __WXMSW__ || __UNIX__

 
 

-    return info->CreateObject();
-}

 
 

-void wxLibrary::PrepareClasses(wxClassInfo *first)
+bool wxDynamicLibrary::Load(const wxString& libnameOrig, int flags)

 {
 {

-    // 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 = (wxClassInfo *)info->GetNext();
-    }
+    wxASSERT_MSG(m_handle == 0, wxT("Library already loaded."));

 
 

-    // Set base pointers for each wxClassInfo
-    info = first;
-    while (info)
+    // add the proper extension for the DLL ourselves unless told not to
+    wxString libname = libnameOrig;
+    if ( !(flags & wxDL_VERBATIM) )

     {
     {

-        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;
+        // and also check that the libname doesn't already have it
+        wxString ext;
+        wxFileName::SplitPath(libname, NULL, NULL, &ext);
+        if ( ext.empty() )
+        {
+            libname += GetDllExt();
+        }

     }
     }

-}

 
 

-void *wxLibrary::GetSymbol(const wxString& symbname)
-{
-   return wxDllLoader::GetSymbol(m_handle, symbname);
-}
-
-// ---------------------------------------------------------------------------
-// wxDllLoader
-// ---------------------------------------------------------------------------
-
-/* static */
-wxString wxDllLoader::GetDllExt()
-{
-    wxString ext;
-
-#if defined(__WINDOWS__) || defined(__WXPM__) || defined(__EMX__)
-    ext = _T(".dll");
-#elif defined(__UNIX__)
-#   if defined(__HPUX__)
-        ext = _T(".sl");
-#   else //__HPUX__
-        ext = _T(".so");
-#   endif //__HPUX__
+    // different ways to load a shared library
+    //
+    // FIXME: should go to the platform-specific files!
+#if 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
 
 #endif
 

-    return ext;
-}
-
-/* static */
-wxDllType
-wxDllLoader::GetProgramHandle(void)
-{
-#if defined( HAVE_DLOPEN ) && !defined(__EMX__)
-   // optain handle for main program
-   return dlopen(NULL, RTLD_NOW/*RTLD_LAZY*/);
-#elif defined (HAVE_SHL_LOAD)
-   // shl_findsymbol with NULL handle looks up in main program
-   return 0;
+    if ( m_handle == 0 && !(flags & wxDL_QUIET) )
+    {
+#ifdef wxHAVE_DYNLIB_ERROR
+        Error();

 #else
 #else

-   wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2"));
-   return 0;
+        wxLogSysError(_("Failed to load shared library '%s'"), libname.c_str());

 #endif
 #endif

-}
-
-/* static */
-wxDllType
-wxDllLoader::LoadLibrary(const wxString & libname, bool *success)
-{
-    wxDllType handle;
-
-#if defined(__WXMAC__) && !defined(__UNIX__)
-    FSSpec myFSSpec ;
-    Ptr myMainAddr ;
-    Str255 myErrName ;
-
-    wxMacPathToFSSpec( libname , &myFSSpec ) ;
-    if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr ,
-                myErrName ) != noErr )
-    {
-        p2cstr( myErrName ) ;
-        wxASSERT_MSG( 1 , (char*)myErrName ) ;
-        return NULL ;
-    }
-#elif defined(__WXPM__) || defined(__EMX__)
-    char zError[256] = "";
-    wxDllOpen(zError, libname, handle);
-#else // !Mac
-    handle = wxDllOpen(libname);
-#endif // OS
-
-    if ( !handle )
-    {
-        wxString msg(_("Failed to load shared library '%s'"));
-
-#ifdef HAVE_DLERROR
-        const char *errmsg = dlerror();
-        if ( errmsg )
-        {
-            // 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());
-        }
-    }
-
-    if ( success )
-    {
-        *success = handle != 0;

     }
 
     }
 

-    return handle;
+    return IsLoaded();

 }
 
 }
 

+// 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 */
 
 /* static */

-void
-wxDllLoader::UnloadLibrary(wxDllType handle)
+void wxDynamicLibrary::Unload(wxDllType handle)

 {
 {

-   wxDllClose(handle);
+#if defined(__OS2__) || defined(__EMX__)
+    DosFreeModule( handle );
+#else
+    #error  "runtime shared lib support not implemented"
+#endif

 }
 
 }
 

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

 {
 {

-    void *symbol = NULL;    // return value
+    wxCHECK_MSG( IsLoaded(), NULL,
+                 wxT("Can't load symbol from unloaded library") );

 
 

-#if defined(__WXMAC__) && !defined(__UNIX__)
-    Ptr symAddress ;
-    CFragSymbolClass symClass ;
-    Str255 symName ;
+    void    *symbol = 0;

 
 

-#if TARGET_CARBON
-    c2pstrcpy( (StringPtr) symName , name ) ;
+    wxUnusedVar(symbol);
+#if defined(__WXPM__) || defined(__EMX__)
+    DosQueryProcAddr( m_handle, 1L, name.c_str(), (PFN*)symbol );

 #else
 #else

-    strcpy( (char *) symName , name ) ;
-       c2pstr( (char *) symName ) ;
+    symbol = RawGetSymbol(m_handle, name);

 #endif
 
 #endif
 

-    if ( FindSymbol( dllHandle , symName , &symAddress , &symClass ) == noErr )
-        symbol = (void *)symAddress ;
-#elif defined( __WXPM__ ) || defined(__EMX__)
-    wxDllGetSymbol(dllHandle, symbol);
-#else
-    // mb_str() is necessary in Unicode build
-    symbol = wxDllGetSymbol(dllHandle, name.mb_str());
-#endif
+    if ( success )
+        *success = symbol != NULL;
+
+    return symbol;
+}

 
 

+void *wxDynamicLibrary::GetSymbol(const wxString& name, bool *success) const
+{
+    void *symbol = DoGetSymbol(name, success);

     if ( !symbol )
     {
     if ( !symbol )
     {

+#ifdef wxHAVE_DYNLIB_ERROR
+        Error();
+#else

         wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
                       name.c_str());
         wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
                       name.c_str());

+#endif

     }
     }

+

     return symbol;
 }
 
     return symbol;
 }
 

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

 
 

-wxLibraries::wxLibraries():m_loaded(wxKEY_STRING)
+/*static*/
+wxString
+wxDynamicLibrary::CanonicalizeName(const wxString& name,
+                                   wxDynamicLibraryCategory cat)

 {
 {

-}
+    wxString nameCanonic;

 
 

-wxLibraries::~wxLibraries()
-{
-    wxNode *node = m_loaded.First();
+    // under Unix the library names usually start with "lib" prefix, add it
+#if defined(__UNIX__) && !defined(__EMX__)
+    switch ( cat )
+    {
+        default:
+            wxFAIL_MSG( wxT("unknown wxDynamicLibraryCategory value") );
+            // fall through

 
 

-    while (node) {
-        wxLibrary *lib = (wxLibrary *)node->Data();
-        delete lib;
+        case wxDL_MODULE:
+            // don't do anything for modules, their names are arbitrary
+            break;

 
 

-        node = node->Next();
+        case wxDL_LIBRARY:
+            // library names should start with "lib" under Unix
+            nameCanonic = wxT("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)

 {
 {

-    wxNode *node;
-    wxLibrary *lib;
-    wxClassInfo *old_sm_first;
-
-#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())) != NULL)
-        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 suffix;
+    if ( cat == wxDL_PLUGIN_GUI )

     {
     {

-        wxString fullname(tokenizer.NextToken());
+        suffix = wxPlatformInfo::Get().GetPortIdShortName();
+    }
+#if wxUSE_UNICODE
+    suffix << wxT('u');
+#endif
+#ifdef __WXDEBUG__
+    suffix << wxT('d');
+#endif

 
 

-        fullname << wxT('/') << libname;
-        if ( wxFileExists(fullname) )
-        {
-            libname = fullname;
+    if ( !suffix.empty() )
+        suffix = wxString(wxT("_")) + suffix;

 
 

-            // found the library
-            break;
-        }
-    }
-    //else: not found in the path, leave the name as is (secutiry risk?)
+#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

 
 

-#endif // __UNIX__
+    suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
+                                           wxRELEASE_NUMBER));
+#undef wxDLLVER
+#undef WXSTRINGIZE
+
+#ifdef __WINDOWS__
+    // Add compiler identification:
+    #if defined(__GNUG__)
+        suffix << wxT("_gcc");
+    #elif defined(__VISUALC__)
+        suffix << wxT("_vc");
+    #elif defined(__WATCOMC__)
+        suffix << wxT("_wat");
+    #elif defined(__BORLANDC__)
+        suffix << wxT("_bcc");
+    #endif

 #endif
 
 #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
-       lib = NULL;
-    return lib;
+    return CanonicalizeName(name + suffix, wxDL_MODULE);

 }
 
 }
 

-wxObject *wxLibraries::CreateObject(const wxString& path)
+/*static*/
+wxString wxDynamicLibrary::GetPluginsDirectory()

 {
 {

-    wxNode *node = m_loaded.First();
-    wxObject *obj;
-
-    while (node) {
-        obj = ((wxLibrary *)node->Data())->CreateObject(path);
-        if (obj)
-            return obj;
+#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;

 
 

-        node = node->Next();
-    }
-    return NULL;
+#else // ! __UNIX__
+    return wxEmptyString;
+#endif

 }
 
 }
 

+

 #endif // wxUSE_DYNLIB_CLASS
 #endif // wxUSE_DYNLIB_CLASS