/////////////////////////////////////////////////////////////////////////////
-// 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
+// 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
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
-# pragma implementation "dynlib.h"
-#endif
-
#include "wx/wxprec.h"
#ifdef __BORLANDC__
- #pragma hdrstop
+ #pragma hdrstop
#endif
-#if wxUSE_DYNLIB_CLASS && !wxUSE_DYNAMIC_LOADER
-
-#if defined(__WINDOWS__)
- #include "wx/msw/private.h"
-#endif
+#if wxUSE_DYNLIB_CLASS
#include "wx/dynlib.h"
-#include "wx/filefn.h"
-#include "wx/intl.h"
-#include "wx/log.h"
-
-#if defined(__WXMAC__)
- #include "wx/mac/private.h"
-#endif
-// ----------------------------------------------------------------------------
-// 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 0;
-}
-
-#elif defined(__DARWIN__)
-/* 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*.
- */
-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
-#elif defined(__WXMAC__)
-# define wxDllClose(handle) CloseConnection(&((CFragConnectionID)handle))
-#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
// ============================================================================
-// 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;
-
- // Some system may use a local heap for library.
- get_first = (t_get_first)GetSymbol(_T("wxGetClassFirst"));
- // It is a wxWindows DLL.
- if (get_first)
- PrepareClasses(get_first());
-}
-
-wxLibrary::~wxLibrary()
-{
- if ( m_handle )
- {
- wxDllClose(m_handle);
- }
-}
+// for MSW/Unix it is defined in platform-specific file
+#if !(defined(__WINDOWS__) || defined(__UNIX__)) || defined(__EMX__)
-wxObject *wxLibrary::CreateObject(const wxString& name)
+wxDllType wxDynamicLibrary::GetProgramHandle()
{
- wxClassInfo *info = (wxClassInfo *)classTable.Get(name);
-
- if (!info)
- return NULL;
-
- return info->CreateObject();
-}
-
-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->m_next;
- }
-
- // 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;
- }
+ wxFAIL_MSG( wxT("GetProgramHandle() is not implemented under this platform"));
+ return 0;
}
-void *wxLibrary::GetSymbol(const wxString& symbname)
-{
- return wxDllLoader::GetSymbol(m_handle, symbname);
-}
+#endif // __WINDOWS__ || __UNIX__
-// ---------------------------------------------------------------------------
-// wxDllLoader
-// ---------------------------------------------------------------------------
-
-
-#if defined(__WINDOWS__) || defined(__WXPM__) || defined(__EMX__)
-const wxString wxDllLoader::ms_dllext( _T(".dll") );
-#elif defined(__UNIX__)
-#if defined(__HPUX__)
-const wxString wxDllLoader::ms_dllext( _T(".sl") );
-#else
-const wxString wxDllLoader::ms_dllext( _T(".so") );
-#endif
-#elif defined(__WXMAC__)
-const wxString wxDllLoader::ms_dllext( _T("") );
-#endif
-/* static */
-wxDllType wxDllLoader::GetProgramHandle()
+bool wxDynamicLibrary::Load(const wxString& libnameOrig, int flags)
{
-#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;
-#else
- wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2"));
- return 0;
-#endif
-}
+ wxASSERT_MSG(m_handle == 0, wxT("Library already loaded."));
-/* static */
-wxDllType wxDllLoader::LoadLibrary(const wxString & libname, bool *success)
-{
- wxDllType handle;
- bool failed = FALSE;
-
-#if defined(__WXMAC__) && !defined(__UNIX__)
- FSSpec myFSSpec;
- Ptr myMainAddr;
- Str255 myErrName;
-
- wxMacFilename2FSSpec( libname , &myFSSpec );
-
- if( GetDiskFragment( &myFSSpec,
- 0,
- kCFragGoesToEOF,
- "\p",
- kPrivateCFragCopy,
- &((CFragConnectionID)handle),
- &myMainAddr,
- myErrName ) != noErr )
+ // add the proper extension for the DLL ourselves unless told not to
+ wxString libname = libnameOrig;
+ if ( !(flags & wxDL_VERBATIM) )
{
- p2cstr( myErrName );
- wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
- libname.c_str(),
- (char*)myErrName );
- handle = 0;
- failed = TRUE;
+ // 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);
+ }
}
-#elif defined(__WXPM__) || defined(__EMX__)
- char zError[256] = "";
- wxDllOpen(zError, libname, handle);
-
-#else
- handle = wxDllOpen(libname);
-
+ // 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
- if ( !handle )
+ if ( m_handle == 0 && !(flags & wxDL_QUIET) )
{
- wxString msg(_("Failed to load shared library '%s'"));
-
-#ifdef HAVE_DLERROR
- const wxChar *err = dlerror();
- if( err )
- {
- failed = TRUE;
- wxLogError( msg, err );
- }
+#ifdef wxHAVE_DYNLIB_ERROR
+ Error();
#else
- failed = TRUE;
- wxLogSysError( msg, libname.c_str() );
+ wxLogSysError(_("Failed to load shared library '%s'"), libname.c_str());
#endif
}
- if ( success )
- *success = !failed;
-
- 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(__WINDOWS__) && !defined(__UNIX__)) || defined(__EMX__)
/* 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, bool *success)
+#endif // !(__WINDOWS__ || __UNIX__)
+
+void *wxDynamicLibrary::DoGetSymbol(const wxString &name, bool *success) const
{
- bool failed = FALSE;
- void *symbol = 0;
+ 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
- strcpy( (char *) symName, name );
- c2pstr( (char *) symName );
+ symbol = RawGetSymbol(m_handle, name);
#endif
- if( FindSymbol( ((CFragConnectionID)dllHandle), symName, &symAddress, &symClass ) == noErr )
- symbol = (void *)symAddress;
-
-#elif defined(__WXPM__) || defined(__EMX__)
- wxDllGetSymbol(dllHandle, symbol);
-#else // Windows or Unix
-
- // mb_str() is necessary in Unicode build
- //
- // "void *" cast is needed by gcc 3.1 + w32api 1.4, don't ask me why
- symbol = (void *)wxDllGetSymbol(dllHandle, name.mb_str());
+ if ( success )
+ *success = symbol != NULL;
-#endif // OS
+ return symbol;
+}
+void *wxDynamicLibrary::GetSymbol(const wxString& name, bool *success) const
+{
+ void *symbol = DoGetSymbol(name, success);
if ( !symbol )
{
-#ifdef HAVE_DLERROR
- const wxChar *err = dlerror();
- if( err )
- {
- wxLogError(wxT("%s"), err);
- }
+#ifdef wxHAVE_DYNLIB_ERROR
+ Error();
#else
- failed = TRUE;
wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
name.c_str());
#endif
}
- if( success )
- *success = !failed;
-
return symbol;
}
-// ---------------------------------------------------------------------------
-// wxLibraries (only one instance should normally exist)
-// ---------------------------------------------------------------------------
-
-wxLibraries::wxLibraries():m_loaded(wxKEY_STRING)
-{
-}
+// ----------------------------------------------------------------------------
+// informational methods
+// ----------------------------------------------------------------------------
-wxLibraries::~wxLibraries()
+/*static*/
+wxString wxDynamicLibrary::GetDllExt(wxDynamicLibraryCategory cat)
{
- wxNode *node = m_loaded.First();
-
- while (node) {
- wxLibrary *lib = (wxLibrary *)node->Data();
- delete lib;
-
- node = node->Next();
+ 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 ".so";
+#endif
}
-wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
+/*static*/
+wxString
+wxDynamicLibrary::CanonicalizeName(const wxString& name,
+ wxDynamicLibraryCategory cat)
{
- wxLibrary *lib;
- wxClassInfo *old_sm_first;
- wxNode *node = m_loaded.Find(name.GetData());
-
- if (node != NULL)
- return ((wxLibrary *)node->Data());
+ wxString nameCanonic;
- // If DLL shares data, this is necessary.
- old_sm_first = wxClassInfo::sm_first;
- wxClassInfo::sm_first = NULL;
-
- wxString libname = ConstructLibraryName(name);
-
- bool success = FALSE;
- wxDllType handle = wxDllLoader::LoadLibrary(libname, &success);
- if(success)
+ // under Unix the library names usually start with "lib" prefix, add it
+#if defined(__UNIX__) && !defined(__EMX__)
+ switch ( cat )
{
- lib = new wxLibrary(handle);
- wxClassInfo::sm_first = old_sm_first;
-
- m_loaded.Append(name.GetData(), lib);
+ 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;
}
- else
- lib = NULL;
- return lib;
-}
-
-wxObject *wxLibraries::CreateObject(const wxString& path)
-{
- wxNode *node = m_loaded.First();
- wxObject *obj;
+#endif
- while (node) {
- obj = ((wxLibrary *)node->Data())->CreateObject(path);
- if (obj)
- return obj;
+ nameCanonic << name << GetDllExt(cat);
- node = node->Next();
- }
- return NULL;
+ return nameCanonic;
}
-#endif // wxUSE_DYNLIB_CLASS && !wxUSE_DYNAMIC_LOADER
-
-#if defined(__DARWIN__) && (wxUSE_DYNLIB_CLASS || wxUSE_DYNAMIC_LOADER)
-// ---------------------------------------------------------------------------
-// For Darwin/Mac OS X
-// supply the sun style dlopen functions in terms of Darwin NS*
-// ---------------------------------------------------------------------------
-
-#include <stdio.h>
-#include <mach-o/dyld.h>
-
-static char dl_last_error[1024];
-
-static
-void TranslateError(const char *path, int number)
+/*static*/
+wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
+ wxPluginCategory cat)
{
- unsigned int index;
- static char *OFIErrorStrings[] =
+ wxString suffix;
+ if ( cat == wxDL_PLUGIN_GUI )
{
- "%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;
+ suffix = wxPlatformInfo::Get().GetPortIdShortName();
}
- sprintf(dl_last_error, OFIErrorStrings[index], path, number);
-}
-
-const char *dlerror()
-{
- return dl_last_error;
-}
+#if wxUSE_UNICODE
+ suffix << wxT('u');
+#endif
+#ifdef __WXDEBUG__
+ suffix << wxT('d');
+#endif
-void *dlopen(const char *path, int WXUNUSED(mode) /* mode is ignored */)
-{
- int dyld_result;
- NSObjectFileImage ofile;
- NSModule handle = NULL;
+ if ( !suffix.empty() )
+ suffix = wxString(wxT("_")) + suffix;
- dyld_result = NSCreateObjectFileImageFromFile(path, &ofile);
- if (dyld_result != NSObjectFileImageSuccess)
- {
- TranslateError(path, dyld_result);
- }
- else
- {
- // 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);
- }
+#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
- return handle;
-}
+ 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
-int dlclose(void *handle)
-{
- NSUnLinkModule( handle, NSUNLINKMODULE_OPTION_NONE);
- return 0;
+ return CanonicalizeName(name + suffix, wxDL_MODULE);
}
-void *dlsym(void *WXUNUSED(handle), const char *symbol)
+/*static*/
+wxString wxDynamicLibrary::GetPluginsDirectory()
{
- void *addr;
+#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;
- if (NSIsSymbolNameDefined(symbol)) {
- addr = NSAddressOfSymbol(NSLookupAndBindSymbol(symbol));
- }
- else {
- addr = NULL;
- }
- return addr;
+#else // ! __UNIX__
+ return wxEmptyString;
+#endif
}
-#endif // defined(__DARWIN__) && (wxUSE_DYNLIB_CLASS || wxUSE_DYNAMIC_LOADER)
+
+#endif // wxUSE_DYNLIB_CLASS
projects / wxWidgets.git / blobdiff