X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/509201463dbd3bce8aff762c664b111a8f2c3412..45e0dc94770d598a1cc84d83730d470dd1cfbcca:/src/common/dynlib.cpp diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp index b4a60768fb..6dd93ebcdc 100644 --- a/src/common/dynlib.cpp +++ b/src/common/dynlib.cpp @@ -18,56 +18,100 @@ // ---------------------------------------------------------------------------- #ifdef __GNUG__ - #pragma implementation "dynlib.h" +# pragma implementation "dynlib.h" #endif #include "wx/wxprec.h" -#ifdef __BORLANDC__ +#ifdef __BORLANDC__ #pragma hdrstop -#endif //__BORLANDC__ +#endif + +#if wxUSE_DYNLIB_CLASS && !wxUSE_DYNAMIC_LOADER -#if wxUSE_DYNLIB_CLASS +#if defined(__WINDOWS__) + #include "wx/msw/private.h" +#endif #include "wx/dynlib.h" #include "wx/filefn.h" #include "wx/intl.h" #include "wx/log.h" -#include "wx/tokenzr.h" + +#if defined(__WXMAC__) + #include "wx/mac/private.h" +#endif // ---------------------------------------------------------------------------- // conditional compilation // ---------------------------------------------------------------------------- -#if defined(HAVE_DLOPEN) - #define wxDllOpen(lib) dlopen(lib.fn_str(), RTLD_LAZY) - #define wxDllGetSymbol(handle, name) dlsym(handle, name.mb_str()) - #define wxDllClose dlclose +#if defined(__WXPM__) || defined(__EMX__) +# define INCL_DOS +# include +# 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 +# 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 (void *)0; - } -#elif defined(__WINDOWS__) - #include +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__ - #define wxDllOpen(lib) ::LoadLibraryEx(lib, 0, 0) - #else // Win16 - #define wxDllOpen(lib) ::LoadLibrary(lib) - #endif // Win32/16 - #define wxDllGetSymbol(handle, name) ::GetProcAddress(handle, name) - #define wxDllClose ::FreeLibrary +# 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." +# error "Don't know how to load shared libraries on this platform." #endif // OS // --------------------------------------------------------------------------- @@ -76,33 +120,20 @@ wxLibraries wxTheLibraries; -// ---------------------------------------------------------------------------- -// private functions -// ---------------------------------------------------------------------------- +// ============================================================================ +// 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(basename); - -#if defined(__UNIX__) - #if defined(__HPUX__) - fullname << ".sl"; - #else //__HPUX__ - fullname << ".so"; - #endif //__HPUX__ -#elif defined(__WINDOWS__) - fullname << ".dll"; -#endif + wxString fullname; + fullname << basename << wxDllLoader::GetDllExt(); return fullname; } -// ============================================================================ -// implementation -// ============================================================================ - // --------------------------------------------------------------------------- // wxLibrary (one instance per dynamic library) // --------------------------------------------------------------------------- @@ -147,7 +178,7 @@ void wxLibrary::PrepareClasses(wxClassInfo *first) { if (info->m_className) classTable.Put(info->m_className, (wxObject *)info); - info = info->GetNext(); + info = info->m_next; } // Set base pointers for each wxClassInfo @@ -164,30 +195,160 @@ void wxLibrary::PrepareClasses(wxClassInfo *first) void *wxLibrary::GetSymbol(const wxString& symbname) { - void *symbol = NULL; // return value + return wxDllLoader::GetSymbol(m_handle, symbname); +} -#if defined( __WXMAC__ ) - Ptr symAddress ; - CFragSymbolClass symClass ; - Str255 symName ; +// --------------------------------------------------------------------------- +// wxDllLoader +// --------------------------------------------------------------------------- - strcpy( (char*) symName , symbname ) ; - c2pstr( (char*) symName ) ; - if ( FindSymbol( m_handle , symName , &symAddress , &symClass ) == noErr ) +#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() +{ +#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 +} + +/* 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 ) { - symbol = (void *)symAddress ; + p2cstr( myErrName ); + wxLogSysError( _("Failed to load shared library '%s' Error '%s'"), + libname.c_str(), + (char*)myErrName ); + handle = 0; + failed = TRUE; } + +#elif defined(__WXPM__) || defined(__EMX__) + char zError[256] = ""; + wxDllOpen(zError, libname, handle); + +#else + handle = wxDllOpen(libname); + +#endif + + if ( !handle ) + { + wxString msg(_("Failed to load shared library '%s'")); + +#ifdef HAVE_DLERROR + const wxChar *err = dlerror(); + if( err ) + { + failed = TRUE; + wxLogError( msg, err ); + } #else - symbol = wxDllGetSymbol(m_handle, symbname); + failed = TRUE; + wxLogSysError( msg, libname.c_str() ); +#endif + } + + if ( success ) + *success = !failed; + + return handle; +} + + +/* static */ +void wxDllLoader::UnloadLibrary(wxDllType handle) +{ + wxDllClose(handle); +} + +/* static */ +void *wxDllLoader::GetSymbol(wxDllType dllHandle, const wxString &name, bool *success) +{ + bool failed = FALSE; + void *symbol = 0; + +#if defined(__WXMAC__) && !defined(__UNIX__) + Ptr symAddress; + CFragSymbolClass symClass; + Str255 symName; + +#if TARGET_CARBON + c2pstrcpy( (StringPtr) symName, name ); +#else + strcpy( (char *) symName, name ); + c2pstr( (char *) symName ); +#endif + if( FindSymbol( ((CFragConnectionID)dllHandle), symName, &symAddress, &symClass ) == noErr ) + symbol = (void *)symAddress; + +#elif defined(__WXPM__) || defined(__EMX__) + wxDllGetSymbol(dllHandle, symbol); + +#else + // mb_str() is necessary in Unicode build + symbol = wxDllGetSymbol(dllHandle, name.mb_str()); + #endif if ( !symbol ) { + wxString msg(_("wxDllLoader failed to GetSymbol '%s'")); + +#ifdef HAVE_DLERROR + const wxChar *err = dlerror(); + if( err ) + { + failed = TRUE; + wxLogError( msg, err ); + } +#else + failed = TRUE; wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"), - symbname.c_str()); + name.c_str()); +#endif } + if( success ) + *success = !failed; + return symbol; } @@ -195,7 +356,7 @@ void *wxLibrary::GetSymbol(const wxString& symbname) // wxLibraries (only one instance should normally exist) // --------------------------------------------------------------------------- -wxLibraries::wxLibraries() +wxLibraries::wxLibraries():m_loaded(wxKEY_STRING) { } @@ -213,92 +374,142 @@ wxLibraries::~wxLibraries() wxLibrary *wxLibraries::LoadLibrary(const wxString& name) { - wxNode *node; - wxLibrary *lib; + wxLibrary *lib; wxClassInfo *old_sm_first; + wxNode *node = m_loaded.Find(name.GetData()); - if ( (node = m_loaded.Find(name.GetData())) ) + if (node != NULL) 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); + wxString libname = 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, _T(':')); - while ( tokenizer.HasMoreToken() ) + bool success = FALSE; + wxDllType handle = wxDllLoader::LoadLibrary(libname, &success); + if(success) { - wxString fullname(tokenizer.NextToken()); + lib = new wxLibrary(handle); + wxClassInfo::sm_first = old_sm_first; - fullname << '/' << lib_name; - if ( wxFileExists(fullname) ) - { - lib_name = fullname; + m_loaded.Append(name.GetData(), lib); + } + else + lib = NULL; + return lib; +} - // found the library - break; - } +wxObject *wxLibraries::CreateObject(const wxString& path) +{ + wxNode *node = m_loaded.First(); + wxObject *obj; + + while (node) { + obj = ((wxLibrary *)node->Data())->CreateObject(path); + if (obj) + return obj; + + node = node->Next(); } - //else: not found in the path, leave the name as is (secutiry risk?) + return NULL; +} + +#ifdef __DARWIN__ +// --------------------------------------------------------------------------- +// For Darwin/Mac OS X +// supply the sun style dlopen functions in terms of Darwin NS* +// --------------------------------------------------------------------------- -#endif // __UNIX__ +extern "C" { +#import +}; - wxDllType handle; +enum dyldErrorSource +{ + OFImage, +}; -#if defined(__WXMAC__) - FSSpec myFSSpec ; - Ptr myMainAddr ; - Str255 myErrName ; +static char dl_last_error[1024]; - wxMacPathToFSSpec( lib_name , &myFSSpec ) ; - if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr , - myErrName ) != noErr ) +static +void TranslateError(const char *path, enum dyldErrorSource type, int number) +{ + unsigned int index; + static char *OFIErrorStrings[] = { - p2cstr( myErrName ) ; - wxASSERT_MSG( 1 , (char*)myErrName ) ; - return NULL ; - } -#else // !Mac - handle = wxDllOpen(lib_name); -#endif // OS - - if ( !handle ) + "%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])) + + switch (type) { - wxLogSysError(_("Failed to load shared library '%s'"), - lib_name.c_str()); - - return NULL; + case OFImage: + index = number; + if (index > NUM_OFI_ERRORS - 1) { + index = NUM_OFI_ERRORS - 1; + } + sprintf(dl_last_error, OFIErrorStrings[index], path, number); + break; + + default: + sprintf(dl_last_error, "%s(%d): Totally unknown error type %d\n", + path, number, type); + break; } +} - lib = new wxLibrary(handle); +const char *dlerror() +{ + return dl_last_error; +} - wxClassInfo::sm_first = old_sm_first; +void *dlopen(const char *path, int mode /* mode is ignored */) +{ + int dyld_result; + NSObjectFileImage ofile; + NSModule handle = NULL; - m_loaded.Append(name.GetData(), lib); + dyld_result = NSCreateObjectFileImageFromFile(path, &ofile); + if (dyld_result != NSObjectFileImageSuccess) + { + TranslateError(path, OFImage, 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, TRUE); + } - return lib; + return handle; } -wxObject *wxLibraries::CreateObject(const wxString& path) +int dlclose(void *handle) /* stub only */ { - wxNode *node = m_loaded.First(); - wxObject *obj; + return 0; +} - while (node) { - obj = ((wxLibrary *)node->Data())->CreateObject(path); - if (obj) - return obj; +void *dlsym(void *handle, const char *symbol) +{ + void *addr; - node = node->Next(); + if (NSIsSymbolNameDefined(symbol)) { + addr = NSAddressOfSymbol(NSLookupAndBindSymbol(symbol)); } - return NULL; + else { + addr = NULL; + } + return addr; } +#endif // __DARWIN__ + #endif // wxUSE_DYNLIB_CLASS