/////////////////////////////////////////////////////////////////////////////
-// 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)
+
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
#include "wx/wxprec.h"
-#ifdef __BORLANDC__
+#ifdef __BORLANDC__
#pragma hdrstop
-#endif //__BORLANDC__
+#endif
-#ifndef WX_PRECOMP
-#endif //WX_PRECOMP
+#if wxUSE_DYNLIB_CLASS
-#include <wx/dynlib.h>
-#include <wx/filefn.h>
-#include <wx/list.h>
-#include <wx/string.h>
+#include "wx/dynlib.h"
+#include "wx/filefn.h"
+#include "wx/intl.h"
+#include "wx/log.h"
+#include "wx/utils.h"
+#include "wx/filename.h" // for SplitPath()
+#include "wx/app.h"
+#include "wx/apptrait.h"
-// ---------------------------------------------------------------------------
-// System dependent include
-// ---------------------------------------------------------------------------
+#include "wx/arrimpl.cpp"
-#if defined(__UNIX__)
-#include <dlfcn.h>
+#if defined(__WXMAC__)
+ #include "wx/mac/private.h"
#endif
-#ifdef __WINDOWS__
-#include <windows.h>
-#endif
+WX_DEFINE_USER_EXPORTED_OBJARRAY(wxDynamicLibraryDetailsArray)
-#ifdef LoadLibrary
-#undef LoadLibrary
-#endif
+// ============================================================================
+// implementation
+// ============================================================================
// ---------------------------------------------------------------------------
-// Global variables
+// wxDynamicLibrary
// ---------------------------------------------------------------------------
-wxLibraries wxTheLibraries;
+#if defined(__WXPM__) || defined(__EMX__)
+ const wxChar *wxDynamicLibrary::ms_dllext = _T(".dll");
+#elif defined(__WXMAC__) && !defined(__DARWIN__)
+ const wxChar *wxDynamicLibrary::ms_dllext = wxEmptyString;
+#endif
-// ---------------------------------------------------------------------------
-// wxLibrary (one instance per dynamic library
-// ---------------------------------------------------------------------------
+// for MSW/Unix it is defined in platform-specific file
+#if !(defined(__WXMSW__) || defined(__UNIX__)) || defined(__EMX__)
-wxLibrary::wxLibrary(void *handle)
+wxDllType wxDynamicLibrary::GetProgramHandle()
{
- typedef wxClassInfo *(*t_get_first)(void);
- t_get_first get_first;
+ wxFAIL_MSG( wxT("GetProgramHandle() is not implemented under this platform"));
+ return 0;
+}
- m_handle = handle;
- m_destroy = TRUE;
+#endif // __WXMSW__ || __UNIX__
- // 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()
+bool wxDynamicLibrary::Load(const wxString& libnameOrig, int flags)
{
- if (m_handle && m_destroy) {
-#if defined(__UNIX__)
- dlclose(m_handle);
+ 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), (PSZ)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);
-#endif
- }
-}
-wxObject *wxLibrary::CreateObject(const wxString& name)
-{
- wxClassInfo *info = (wxClassInfo *)classTable.Get(name);
-
- 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)
-{
- // 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;
- }
-}
+// 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__)
-void *wxLibrary::GetSymbol(const wxString& symbname)
+/* static */
+void wxDynamicLibrary::Unload(wxDllType handle)
{
-#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 ;
- }
+#if defined(__OS2__) || defined(__EMX__)
+ DosFreeModule( handle );
+#elif defined(__WXMAC__) && !defined(__DARWIN__)
+ CloseConnection( (CFragConnectionID*) &handle );
+#else
+ #error "runtime shared lib support not implemented"
#endif
- return NULL;
}
-// ---------------------------------------------------------------------------
-// wxLibraries (only one instance should normally exist)
-// ---------------------------------------------------------------------------
+#endif // !(__WXMSW__ || __UNIX__)
-wxLibraries::wxLibraries()
+void *wxDynamicLibrary::DoGetSymbol(const wxString &name, bool *success) const
{
-}
-
-wxLibraries::~wxLibraries()
-{
- wxNode *node = m_loaded.First();
+ 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
+ if( FindSymbol( m_handle, symName, &symAddress, &symClass ) == noErr )
+ symbol = (void *)symAddress;
+#elif defined(__WXPM__) || defined(__EMX__)
+ DosQueryProcAddr( m_handle, 1L, (PSZ)name.c_str(), (PFN*)symbol );
+#else
+ symbol = RawGetSymbol(m_handle, name);
+#endif
- while (node) {
- wxLibrary *lib = (wxLibrary *)node->Data();
- delete lib;
+ if ( success )
+ *success = symbol != NULL;
- node = node->Next();
- }
+ 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;
- wxClassInfo *old_sm_first;
-
- if ( (node = m_loaded.Find(name.GetData())) )
- return ((wxLibrary *)node->Data());
-
- // If DLL shares data, this is necessary.
- old_sm_first = wxClassInfo::sm_first;
- wxClassInfo::sm_first = NULL;
-
-#if defined(__UNIX__)
- 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;
+}
- printf("error = %s\n", dlerror());
+// ----------------------------------------------------------------------------
+// informational methods
+// ----------------------------------------------------------------------------
- if (!handle)
- return NULL;
-#elif defined(__WINDOWS__)
- lib_name += ".dll";
+/*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;
+}
-#ifdef UNICODE
- HMODULE handle = LoadLibraryW(lib_name);
-#else
-#ifdef __WIN16__
- HMODULE handle = ::LoadLibrary(lib_name);
-#else
- HMODULE handle = LoadLibraryA(lib_name);
+/*static*/
+wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
+ wxPluginCategory cat)
+{
+ wxString suffix;
+ if ( cat == wxDL_PLUGIN_GUI )
+ {
+ wxAppTraits *traits = wxAppConsole::GetInstance() ?
+ wxAppConsole::GetInstance()->GetTraits() : NULL;
+ wxASSERT_MSG( traits,
+ _("can't query for GUI plugins name in console applications") );
+ suffix = traits->GetToolkitInfo().shortName;
+ }
+#if wxUSE_UNICODE
+ suffix << _T('u');
#endif
+#ifdef __WXDEBUG__
+ suffix << _T('d');
#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 ;
- }
+
+ if ( !suffix.empty() )
+ suffix = wxString(_T("_")) + suffix;
+
+#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
- return NULL;
+ #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
- lib = new wxLibrary((void *)handle);
+ suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
+ wxRELEASE_NUMBER));
+#undef wxDLLVER
+#undef WXSTRINGIZE
- wxClassInfo::sm_first = old_sm_first;
+#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
- m_loaded.Append(name.GetData(), lib);
- 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
projects / wxWidgets.git / blobdiff