X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8a0d4cf6c5e9fe357ca3e873b81c0fda10e4b217..6012f61212b67d510e4a6393272e867a4ceb58c1:/src/common/dynlib.cpp diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp index 447fb80a87..f400389c4a 100644 --- 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$ -// 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 // ============================================================================ @@ -17,283 +21,307 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "dynlib.h" -#endif - #include "wx/wxprec.h" -#ifdef __BORLANDC__ - #pragma hdrstop -#endif //__BORLANDC__ +#ifdef __BORLANDC__ + #pragma hdrstop +#endif #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, RTLD_LAZY) - #define wxDllGetSymbol(handle, name) dlsym(handle, (char *)name) - #define wxDllClose dlclose -#elif defined(HAVE_SHL_LOAD) - #define wxDllOpen(lib) shl_load(lib, BIND_DEFERRED, 0) - #define wxDllClose shl_unload - static inline void *wxDllGetSymbol(shl_t handle, const char *name) - { - void *sym; - if ( shl_findsym(&handle, name, TYPE_UNDEFINED, &sym) == 0 ) - return sym; - else - return (void *)0; - } -#elif defined(__WINDOWS__) - #define wxDllOpen(lib) ::LoadLibrary(lib) - #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 +#ifndef WX_PRECOMP + #include "wx/intl.h" + #include "wx/log.h" + #include "wx/app.h" + #include "wx/utils.h" +#endif //WX_PRECOMP -// --------------------------------------------------------------------------- -// Global variables -// --------------------------------------------------------------------------- - -wxLibraries wxTheLibraries; +#include "wx/filefn.h" +#include "wx/filename.h" // for SplitPath() +#include "wx/apptrait.h" -// ---------------------------------------------------------------------------- -// private functions -// ---------------------------------------------------------------------------- +#include "wx/arrimpl.cpp" -// 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"; +#if defined(__WXMAC__) + #include "wx/mac/private.h" #endif - return fullname; -} +WX_DEFINE_USER_EXPORTED_OBJARRAY(wxDynamicLibraryDetailsArray) // ============================================================================ // implementation // ============================================================================ // --------------------------------------------------------------------------- -// 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 wxChar *wxDynamicLibrary::ms_dllext = _T(".dll"); +#elif defined(__WXMAC__) && !defined(__DARWIN__) + const wxChar *wxDynamicLibrary::ms_dllext = wxEmptyString; +#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); +#endif // __WXMSW__ || __UNIX__ - if (!info) - return NULL; - 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) + 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) ) { - if (info->m_className) - classTable.Put(info->m_className, (wxObject *)info); - info = info->GetNext(); + // and also check that the libname doesn't already have it + wxString ext; + wxFileName::SplitPath(libname, NULL, NULL, &ext); + if ( ext.empty() ) + { + libname += GetDllExt(); + } } - // Set base pointers for each wxClassInfo - info = first; - while (info) + // 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 ) { - 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; + wxLogSysError( _("Failed to load shared library '%s' Error '%s'"), + libname.c_str(), + wxMacMakeStringFromPascal( myErrName ).c_str() ); + m_handle = 0; } -} -void *wxLibrary::GetSymbol(const wxString& symbname) -{ - void *symbol = NULL; // return value - -#if defined( __WXMAC__ ) - Ptr symAddress ; - CFragSymbolClass symClass ; - Str255 symName ; - - strcpy( (char*) symName , symbname ) ; - c2pstr( (char*) symName ) ; +#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 - if ( FindSymbol( m_handle , symName , &symAddress , &symClass ) == noErr ) + if ( m_handle == 0 ) { - symbol = (void *)symAddress ; - } +#ifdef wxHAVE_DYNLIB_ERROR + Error(); #else - // VZ: hmm... why is WXSTRINGCAST needed? if it's really modified, we - // should make a copy of it - symbol = wxDllGetSymbol(m_handle, WXSTRINGCAST symbname); + wxLogSysError(_("Failed to load shared library '%s'"), libname.c_str()); #endif - - if ( !symbol ) - { - wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"), - symbname.c_str()); } - return symbol; + return IsLoaded(); } -// --------------------------------------------------------------------------- -// wxLibraries (only one instance should normally exist) -// --------------------------------------------------------------------------- +// 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__) -wxLibraries::wxLibraries() +/* static */ +void wxDynamicLibrary::Unload(wxDllType handle) { +#if defined(__OS2__) || defined(__EMX__) + DosFreeModule( handle ); +#elif defined(__WXMAC__) && !defined(__DARWIN__) + CloseConnection( (CFragConnectionID*) &handle ); +#else + #error "runtime shared lib support not implemented" +#endif } -wxLibraries::~wxLibraries() +#endif // !(__WXMSW__ || __UNIX__) + +void *wxDynamicLibrary::DoGetSymbol(const wxString &name, bool *success) const { - 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 { - 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; - - wxString lib_name = ConstructLibraryName(name); - -#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, ':'); - while ( tokenizer.HasMoreToken() ) + void *symbol = DoGetSymbol(name, success); + if ( !symbol ) { - wxString fullname(tokenizer.NextToken()); - - fullname << '/' << lib_name; - if ( wxFileExists(fullname) ) - { - lib_name = fullname; - - // found the library - break; - } +#ifdef wxHAVE_DYNLIB_ERROR + Error(); +#else + wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"), + name.c_str()); +#endif } - //else: not found in the path, leave the name as is (secutiry risk?) -#endif // __UNIX__ + return symbol; +} - wxDllType handle; +// ---------------------------------------------------------------------------- +// informational methods +// ---------------------------------------------------------------------------- -#if defined(__WXMAC__) - FSSpec myFSSpec ; - Ptr myMainAddr ; - Str255 myErrName ; +/*static*/ +wxString +wxDynamicLibrary::CanonicalizeName(const wxString& name, + wxDynamicLibraryCategory cat) +{ + wxString nameCanonic; - wxMacPathToFSSpec( lib_name , &myFSSpec ) ; - if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr , - myErrName ) != noErr ) + // under Unix the library names usually start with "lib" prefix, add it +#if defined(__UNIX__) && !defined(__EMX__) + switch ( cat ) { - p2cstr( myErrName ) ; - wxASSERT_MSG( 1 , (char*)myErrName ) ; - return NULL ; + 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 // !Mac - handle = wxDllOpen(lib_name); -#endif // OS +#else // !__UNIX__ + wxUnusedVar(cat); +#endif // __UNIX__/!__UNIX__ - if ( !handle ) - { - wxLogSysError(_("Failed to load shared library '%s'"), - lib_name.c_str()); + nameCanonic << name << GetDllExt(); + return nameCanonic; +} - return NULL; +/*static*/ +wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name, + wxPluginCategory cat) +{ + wxString suffix; + if ( cat == wxDL_PLUGIN_GUI ) + { + wxAppTraits *traits = wxAppConsole::GetInstance() ? + wxAppConsole::GetInstance()->GetTraits() : NULL; + wxCHECK_MSG( traits, wxEmptyString, + _("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 - lib = new wxLibrary(handle); + if ( !suffix.empty() ) + suffix = wxString(_T("_")) + suffix; - wxClassInfo::sm_first = old_sm_first; +#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 - m_loaded.Append(name.GetData(), lib); + suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION, + wxRELEASE_NUMBER)); +#undef wxDLLVER +#undef WXSTRINGIZE + +#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 - 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