/////////////////////////////////////////////////////////////////////////////
-// Name: dynlib.cpp
+// Name: src/common/dynlib.cpp
// 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
+// ----------------------------------------------------------------------------
-#if defined(__LINUX__) || defined(__SGI__)
-#include <dlfcn.h>
-#endif
+#include "wx/wxprec.h"
-#ifdef __WINDOWS__
-#include <windows.h>
+#ifdef __BORLANDC__
+ #pragma hdrstop
#endif
-// ---------------------------------------------------------------------------
-// Global variables
-// ---------------------------------------------------------------------------
+#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"
-wxLibraries wxTheLibraries;
+#include "wx/arrimpl.cpp"
+
+WX_DEFINE_USER_EXPORTED_OBJARRAY(wxDynamicLibraryDetailsArray)
+
+// ============================================================================
+// implementation
+// ============================================================================
// ---------------------------------------------------------------------------
-// wxLibrary (one instance per dynamic library
+// wxDynamicLibrary
// ---------------------------------------------------------------------------
-wxLibrary::wxLibrary(void *handle)
+// for MSW/Unix it is defined in platform-specific file
+#if !(defined(__WINDOWS__) || defined(__UNIX__)) || defined(__EMX__)
+
+wxDllType wxDynamicLibrary::GetProgramHandle()
{
- typedef wxClassLibrary *(*t_get_list)(void);
- t_get_list get_list;
+ wxFAIL_MSG( wxT("GetProgramHandle() is not implemented under this platform"));
+ return 0;
+}
- m_handle = handle;
+#endif // __WINDOWS__ || __UNIX__
- get_list = (t_get_list)GetSymbol("GetClassList");
- m_liblist = (*get_list)();
-}
-wxLibrary::~wxLibrary()
+bool wxDynamicLibrary::Load(const wxString& libnameOrig, int flags)
{
- if (m_handle) {
- typedef void (*t_free_list)(wxClassLibrary *);
- t_free_list free_list;
-
- free_list = (t_free_list) GetSymbol("FreeClassList");
- if (free_list != NULL)
- free_list(m_liblist);
- else
- delete m_liblist;
-
-#if defined(__LINUX__) || defined(__SGI__)
- dlclose(m_handle);
+ wxASSERT_MSG(m_handle == 0, wxT("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(wxDL_MODULE);
+ }
+ }
+
+ // 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
-#ifdef __WINDOWS__
- FreeLibrary((HMODULE)m_handle);
+
+ if ( m_handle == 0 && !(flags & wxDL_QUIET) )
+ {
+#ifdef wxHAVE_DYNLIB_ERROR
+ Error();
+#else
+ wxLogSysError(_("Failed to load shared library '%s'"), libname.c_str());
#endif
- }
-}
+ }
-wxObject *wxLibrary::CreateObject(const wxString& name)
-{
- return m_liblist->CreateObject(name);
+ return IsLoaded();
}
-void *wxLibrary::GetSymbol(const wxString& symbname)
+// 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(__WINDOWS__) && !defined(__UNIX__)) || defined(__EMX__)
+
+/* static */
+void wxDynamicLibrary::Unload(wxDllType handle)
{
-#if defined(__LINUX__) || defined(__SGI__)
- return dlsym(m_handle, WXSTRINGCAST symbname);
-#endif
-#ifdef __WINDOWS__
- return GetProcAddress(m_handle, WXSTRINGCAST symbname);
+#if defined(__OS2__) || defined(__EMX__)
+ DosFreeModule( handle );
+#else
+ #error "runtime shared lib support not implemented"
#endif
- return NULL;
}
-// ---------------------------------------------------------------------------
-// wxLibraries (only one instance should normally exist)
-// ---------------------------------------------------------------------------
+#endif // !(__WINDOWS__ || __UNIX__)
-wxLibraries::wxLibraries()
+void *wxDynamicLibrary::DoGetSymbol(const wxString &name, bool *success) const
{
-}
+ wxCHECK_MSG( IsLoaded(), NULL,
+ wxT("Can't load symbol from unloaded library") );
-wxLibraries::~wxLibraries()
-{
- wxNode *node = m_loaded.First();
+ void *symbol = 0;
- while (node) {
- wxLibrary *lib = (wxLibrary *)node->Data();
- delete lib;
+ wxUnusedVar(symbol);
+#if defined(__WXPM__) || defined(__EMX__)
+ DosQueryProcAddr( m_handle, 1L, name.c_str(), (PFN*)symbol );
+#else
+ symbol = RawGetSymbol(m_handle, name);
+#endif
- node = node->Next();
- }
+ if ( success )
+ *success = symbol != NULL;
+
+ return symbol;
}
-wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
+void *wxDynamicLibrary::GetSymbol(const wxString& name, bool *success) const
{
- wxString lib_name = name;
- wxNode *node;
- wxLibrary *lib;
-
- if ( (node = m_loaded.Find(name.GetData())) )
- return ((wxLibrary *)node->Data());
-
-#if defined(__LINUX__) || defined(__SGI__)
- lib_name.Prepend("lib");
- lib_name += ".so";
-
- printf("lib_name = %s\n", WXSTRINGCAST lib_name);
+ 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
+ }
- void *handle = dlopen(WXSTRINGCAST lib_name, RTLD_LAZY);
+ return symbol;
+}
- if (!handle)
- return NULL;
-#elif defined( __WINDOWS__ )
- lib_name += ".dll";
+// ----------------------------------------------------------------------------
+// informational methods
+// ----------------------------------------------------------------------------
- HMODULE handle = LoadLibrary(lib_name);
- if (!handle)
- return NULL;
+/*static*/
+wxString wxDynamicLibrary::GetDllExt(wxDynamicLibraryCategory cat)
+{
+ wxUnusedVar(cat);
+#if defined(__WINDOWS__) || defined(__WXPM__) || defined(__EMX__)
+ return ".dll";
+#elif defined(__HPUX__)
+ return ".sl";
+#elif defined(__DARWIN__)
+ switch ( cat )
+ {
+ case wxDL_LIBRARY:
+ return ".dylib";
+ case wxDL_MODULE:
+ return ".bundle";
+ }
+ wxFAIL_MSG("unreachable");
+ return wxString(); // silence gcc warning
#else
- return NULL;
-#endif
-#if defined(__LINUX__) || defined(__SGI__) || defined (__WINDOWS__)
- lib = new wxLibrary((void *)handle);
-
- m_loaded.Append(name.GetData(), lib);
- return lib;
+ return ".so";
#endif
}
-wxObject *wxLibraries::CreateObject(const wxString& path)
+/*static*/
+wxString
+wxDynamicLibrary::CanonicalizeName(const wxString& name,
+ wxDynamicLibraryCategory cat)
{
- wxNode *node = m_loaded.First();
- wxObject *obj;
+ wxString nameCanonic;
+
+ // under Unix the library names usually start with "lib" prefix, add it
+#if defined(__UNIX__) && !defined(__EMX__)
+ switch ( cat )
+ {
+ case wxDL_LIBRARY:
+ // Library names should start with "lib" under Unix.
+ nameCanonic = "lib";
+ break;
+ case wxDL_MODULE:
+ // Module names are arbitrary and should have no prefix added.
+ break;
+ }
+#endif
- while (node) {
- obj = ((wxLibrary *)node->Data())->CreateObject(path);
- if (obj)
- return obj;
+ nameCanonic << name << GetDllExt(cat);
- node = node->Next();
- }
- return NULL;
+ return nameCanonic;
}
-// ---------------------------------------------------------------------------
-// wxClassLibrary (this class is used to access the internal class)
-// ---------------------------------------------------------------------------
-
-wxClassLibrary::wxClassLibrary(void)
+/*static*/
+wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
+ wxPluginCategory cat)
{
-}
+ wxString suffix;
+ if ( cat == wxDL_PLUGIN_GUI )
+ {
+ suffix = wxPlatformInfo::Get().GetPortIdShortName();
+ }
+#if wxUSE_UNICODE
+ suffix << wxT('u');
+#endif
+#ifdef __WXDEBUG__
+ suffix << wxT('d');
+#endif
-wxClassLibrary::~wxClassLibrary(void)
-{
- uint i;
+ if ( !suffix.empty() )
+ suffix = wxString(wxT("_")) + suffix;
- for (i=0;i<m_list.Count();i++)
- delete (m_list[i]);
-}
-
-void wxClassLibrary::RegisterClass(wxClassInfo *class_info,
- const wxString& path)
-{
- wxClassLibInfo *info = new wxClassLibInfo;
+#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
- info->class_info = class_info;
- info->path = path;
- m_list.Add(info);
-}
+ suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
+ wxRELEASE_NUMBER));
+#undef wxDLLVER
+#undef WXSTRINGIZE
-void wxClassLibrary::UnregisterClass(wxClassInfo *class_info)
-{
- uint i = 0;
+#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
- while (i < m_list.Count()) {
- if (m_list[i]->class_info == class_info) {
- delete (m_list[i]);
- m_list.Remove(i);
- return;
- }
- i++;
- }
+ return CanonicalizeName(name + suffix, wxDL_MODULE);
}
-bool wxClassLibrary::CreateObjects(const wxString& path,
- wxArrayClassInfo& objs)
+/*static*/
+wxString wxDynamicLibrary::GetPluginsDirectory()
{
- 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);
-}
+#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;
-bool wxClassLibrary::FetchInfos(const wxString& path,
- wxArrayClassLibInfo& infos)
-{
- 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);
+#else // ! __UNIX__
+ return wxEmptyString;
+#endif
}
-wxObject *wxClassLibrary::CreateObject(const wxString& path)
-{
- 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;
-}
+
+#endif // wxUSE_DYNLIB_CLASS