X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8a0d4cf6c5e9fe357ca3e873b81c0fda10e4b217..5767e836997b965b9d936f1d65244bb886c39025:/src/common/dynlib.cpp?ds=sidebyside diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp index 447fb80a87..c2adec7818 100644 --- a/src/common/dynlib.cpp +++ b/src/common/dynlib.cpp @@ -6,7 +6,7 @@ // Created: 20/07/98 // RCS-ID: $Id$ // Copyright: (c) Guilhem Lavaux -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -17,283 +17,509 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "dynlib.h" +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) +# pragma implementation "dynlib.h" #endif #include "wx/wxprec.h" -#ifdef __BORLANDC__ +#ifdef __BORLANDC__ #pragma hdrstop -#endif //__BORLANDC__ +#endif #if wxUSE_DYNLIB_CLASS +#if defined(__WINDOWS__) + #include "wx/msw/wrapwin.h" +#endif + #include "wx/dynlib.h" #include "wx/filefn.h" #include "wx/intl.h" #include "wx/log.h" -#include "wx/tokenzr.h" +#include "wx/utils.h" +#include "wx/filename.h" // for SplitPath() +#include "wx/app.h" +#include "wx/apptrait.h" -// ---------------------------------------------------------------------------- -// conditional compilation -// ---------------------------------------------------------------------------- +#if defined(__WXMAC__) + #include "wx/mac/private.h" +#endif -#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 +// ============================================================================ +// implementation +// ============================================================================ +#if defined(__DARWIN__) // --------------------------------------------------------------------------- -// Global variables +// For Darwin/Mac OS X +// supply the sun style dlopen functions in terms of Darwin NS* // --------------------------------------------------------------------------- -wxLibraries wxTheLibraries; +/* 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*. + */ -// ---------------------------------------------------------------------------- -// private functions -// ---------------------------------------------------------------------------- +#include +#include + +static char dl_last_error[1024]; -// 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) +static +void TranslateError(const char *path, int number) { - wxString fullname(basename); + unsigned int index; + static char *OFIErrorStrings[] = + { + "%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; + } + sprintf(dl_last_error, OFIErrorStrings[index], path, number); +} -#if defined(__UNIX__) - #if defined(__HPUX__) - fullname << ".sl"; - #else //__HPUX__ - fullname << ".so"; - #endif //__HPUX__ -#elif defined(__WINDOWS__) - fullname << ".dll"; -#endif +const char *dlerror() +{ + return dl_last_error; +} + +void *dlopen(const char *path, int WXUNUSED(mode) /* mode is ignored */) +{ + NSObjectFileImage ofile; + NSModule handle = NULL; - return fullname; + int dyld_result = NSCreateObjectFileImageFromFile(path, &ofile); + if ( dyld_result != NSObjectFileImageSuccess ) + { + handle = NULL; + } + else + { + handle = NSLinkModule + ( + ofile, + path, + NSLINKMODULE_OPTION_BINDNOW | + NSLINKMODULE_OPTION_RETURN_ON_ERROR + ); + } + + if ( !handle ) + TranslateError(path, dyld_result); + + return handle; } -// ============================================================================ -// implementation -// ============================================================================ +int dlclose(void *handle) +{ + NSUnLinkModule( handle, NSUNLINKMODULE_OPTION_NONE); + return 0; +} + +void *dlsym(void *handle, const char *symbol) +{ + // as on many other systems, C symbols have prepended underscores under + // Darwin but unlike the normal dlopen(), NSLookupSymbolInModule() is not + // aware of this + wxCharBuffer buf(strlen(symbol) + 1); + char *p = buf.data(); + p[0] = '_'; + strcpy(p + 1, symbol); + + NSSymbol nsSymbol = NSLookupSymbolInModule( handle, p ); + return nsSymbol ? NSAddressOfSymbol(nsSymbol) : NULL; +} + +#endif // defined(__DARWIN__) + // --------------------------------------------------------------------------- -// wxLibrary (one instance per dynamic library) +// wxDynamicLibrary // --------------------------------------------------------------------------- -wxLibrary::wxLibrary(wxDllType handle) -{ - typedef wxClassInfo *(*t_get_first)(void); - t_get_first get_first; +//FIXME: This class isn't really common at all, it should be moved into +// platform dependent files. - m_handle = handle; +#if defined(__WINDOWS__) || defined(__WXPM__) || defined(__EMX__) + const wxChar *wxDynamicLibrary::ms_dllext = _T(".dll"); +#elif defined(__WXMAC__) && !defined(__DARWIN__) + const wxChar *wxDynamicLibrary::ms_dllext = _T(""); +#elif defined(__UNIX__) + #if defined(__HPUX__) + const wxChar *wxDynamicLibrary::ms_dllext = _T(".sl"); + #elif defined(__DARWIN__) + const wxChar *wxDynamicLibrary::ms_dllext = _T(".bundle"); + #else + const wxChar *wxDynamicLibrary::ms_dllext = _T(".so"); + #endif +#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()); +wxDllType wxDynamicLibrary::GetProgramHandle() +{ +#if defined( HAVE_DLOPEN ) && !defined(__EMX__) + return dlopen(0, RTLD_LAZY); +#elif defined (HAVE_SHL_LOAD) + return PROG_HANDLE; +#else + wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2")); + return 0; +#endif } -wxLibrary::~wxLibrary() +bool wxDynamicLibrary::Load(wxString libname, int flags) { - if ( m_handle ) + wxASSERT_MSG(m_handle == 0, _T("Library already loaded.")); + + // add the proper extension for the DLL ourselves unless told not to + 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 ) { - wxDllClose(m_handle); + wxLogSysError( _("Failed to load shared library '%s' Error '%s'"), + libname.c_str(), + wxMacMakeStringFromPascal( myErrName ).c_str() ); + m_handle = 0; } -} -wxObject *wxLibrary::CreateObject(const wxString& name) -{ - wxClassInfo *info = (wxClassInfo *)classTable.Get(name); +#elif defined(__WXPM__) || defined(__EMX__) + char err[256] = ""; + DosLoadModule(err, sizeof(err), libname.c_str(), &m_handle); - if (!info) - return NULL; +#elif defined(HAVE_DLOPEN) || defined(__DARWIN__) - return info->CreateObject(); -} +#if defined(__VMS) || defined(__DARWIN__) + m_handle = dlopen(libname.fn_str(), 0); // The second parameter is ignored +#else // !__VMS && !__DARWIN__ + int rtldFlags = 0; -void wxLibrary::PrepareClasses(wxClassInfo *first) -{ - // Index all class infos by their class name - wxClassInfo *info = first; - while (info) + if ( flags & wxDL_LAZY ) + { + wxASSERT_MSG( (flags & wxDL_NOW) == 0, + _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") ); +#ifdef RTLD_LAZY + rtldFlags |= RTLD_LAZY; +#else + wxLogDebug(_T("wxDL_LAZY is not supported on this platform")); +#endif + } + else if ( flags & wxDL_NOW ) { - if (info->m_className) - classTable.Put(info->m_className, (wxObject *)info); - info = info->GetNext(); +#ifdef RTLD_NOW + rtldFlags |= RTLD_NOW; +#else + wxLogDebug(_T("wxDL_NOW is not supported on this platform")); +#endif } - // Set base pointers for each wxClassInfo - info = first; - while (info) + if ( flags & wxDL_GLOBAL ) { - 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; +#ifdef RTLD_GLOBAL + rtldFlags |= RTLD_GLOBAL; +#else + wxLogDebug(_T("RTLD_GLOBAL is not supported on this platform.")); +#endif } -} - -void *wxLibrary::GetSymbol(const wxString& symbname) -{ - void *symbol = NULL; // return value -#if defined( __WXMAC__ ) - Ptr symAddress ; - CFragSymbolClass symClass ; - Str255 symName ; + m_handle = dlopen(libname.fn_str(), rtldFlags); +#endif // __VMS || __DARWIN__ ? - strcpy( (char*) symName , symbname ) ; - c2pstr( (char*) symName ) ; +#elif defined(HAVE_SHL_LOAD) + int shlFlags = 0; - if ( FindSymbol( m_handle , symName , &symAddress , &symClass ) == noErr ) + if( flags & wxDL_LAZY ) + { + wxASSERT_MSG( (flags & wxDL_NOW) == 0, + _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") ); + shlFlags |= BIND_DEFERRED; + } + else if( flags & wxDL_NOW ) { - symbol = (void *)symAddress ; + shlFlags |= BIND_IMMEDIATE; } + m_handle = shl_load(libname.fn_str(), BIND_DEFERRED, 0); + +#elif defined(__WINDOWS__) + m_handle = ::LoadLibrary(libname.c_str()); #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); + #error "runtime shared lib support not implemented on this platform" #endif - if ( !symbol ) + if ( m_handle == 0 ) { - wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"), - symbname.c_str()); + wxString msg(_("Failed to load shared library '%s'")); +#if defined(HAVE_DLERROR) && !defined(__EMX__) + +#if wxUSE_UNICODE + wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() ); + const wxChar *err = buffer; +#else + const wxChar *err = dlerror(); +#endif + + if( err ) + wxLogError( msg, err ); +#else + wxLogSysError( msg, libname.c_str() ); +#endif } - return symbol; + return IsLoaded(); } -// --------------------------------------------------------------------------- -// wxLibraries (only one instance should normally exist) -// --------------------------------------------------------------------------- - -wxLibraries::wxLibraries() +/* static */ +void wxDynamicLibrary::Unload(wxDllType handle) { +#if defined(__WXPM__) || defined(__EMX__) + DosFreeModule( handle ); +#elif defined(HAVE_DLOPEN) || defined(__DARWIN__) + dlclose( handle ); +#elif defined(HAVE_SHL_LOAD) + shl_unload( handle ); +#elif defined(__WINDOWS__) + ::FreeLibrary( handle ); +#elif defined(__WXMAC__) && !defined(__DARWIN__) + CloseConnection( (CFragConnectionID*) &handle ); +#else + #error "runtime shared lib support not implemented" +#endif } -wxLibraries::~wxLibraries() +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; - while (node) { - wxLibrary *lib = (wxLibrary *)node->Data(); - delete lib; +#elif defined(__WXPM__) || defined(__EMX__) + DosQueryProcAddr( m_handle, 1L, name.c_str(), (PFN*)symbol ); - node = node->Next(); - } +#elif defined(HAVE_DLOPEN) || defined(__DARWIN__) + symbol = dlsym( m_handle, name.fn_str() ); + +#elif defined(HAVE_SHL_LOAD) + // use local variable since shl_findsym modifies the handle argument + // to indicate where the symbol was found (GD) + wxDllType the_handle = m_handle; + if( shl_findsym( &the_handle, name.fn_str(), TYPE_UNDEFINED, &symbol ) != 0 ) + symbol = 0; + +#elif defined(__WINDOWS__) +#ifdef __WXWINCE__ + symbol = (void*) ::GetProcAddress( m_handle, name ); +#else + symbol = (void*) ::GetProcAddress( m_handle, name.mb_str() ); +#endif + +#else +#error "runtime shared lib support not implemented" +#endif + + if ( success ) + *success = symbol != NULL; + + 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()); +#if defined(HAVE_DLERROR) && !defined(__EMX__) - fullname << '/' << lib_name; - if ( wxFileExists(fullname) ) - { - lib_name = fullname; +#if wxUSE_UNICODE + wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() ); + const wxChar *err = buffer; +#else + const wxChar *err = dlerror(); +#endif - // found the library - break; + if( err ) + { + wxLogError(wxT("%s"), err); } +#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__ - - wxDllType handle; + return symbol; +} -#if defined(__WXMAC__) - FSSpec myFSSpec ; - Ptr myMainAddr ; - Str255 myErrName ; +/*static*/ +wxString +wxDynamicLibrary::CanonicalizeName(const wxString& name, + wxDynamicLibraryCategory +#ifdef __UNIX__ + cat +#else // !__UNIX__ + WXUNUSED(cat) +#endif // __UNIX__/!__UNIX__ + ) +{ + 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 +#ifdef __UNIX__ + 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 +#endif // __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; + 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 - lib = new wxLibrary(handle); + if ( !suffix.empty() ) + suffix = wxString(_T("_")) + suffix; - wxClassInfo::sm_first = old_sm_first; +#define WXSTRINGIZE(x) #x +#ifdef __UNIX__ + #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