X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7a4b9130e341e8ed5192cac76574119fb6664c6c..d2b354f9c9f1473b2d6ff0ab643ebf57dcbfb656:/src/common/dynlib.cpp diff --git a/src/common/dynlib.cpp b/src/common/dynlib.cpp index 4f638aac53..a452cb2c82 100644 --- a/src/common/dynlib.cpp +++ b/src/common/dynlib.cpp @@ -6,223 +6,503 @@ // Created: 20/07/98 // RCS-ID: $Id$ // Copyright: (c) Guilhem Lavaux -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +// ============================================================================ +// declarations +// ============================================================================ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + #ifdef __GNUG__ -#pragma implementation "dynlib.h" +# pragma implementation "dynlib.h" #endif -#include -#include -#include -#include +#include "wx/wxprec.h" -// --------------------------------------------------------------------------- -// System dependent include -// --------------------------------------------------------------------------- +#ifdef __BORLANDC__ + #pragma hdrstop +#endif + +#if wxUSE_DYNLIB_CLASS && !wxUSE_DYNAMIC_LOADER -#ifdef linux -#include +#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" + +#if defined(__WXMAC__) + #include "wx/mac/private.h" +#endif + +// ---------------------------------------------------------------------------- +// conditional compilation +// ---------------------------------------------------------------------------- + +#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 + +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 +#ifdef __WXWINCE__ +# define wxDllOpen(lib) ::LoadLibrary(lib) +#else +# define wxDllOpen(lib) ::LoadLibraryExW(lib, 0, 0) +#endif +#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 + // --------------------------------------------------------------------------- // Global variables // --------------------------------------------------------------------------- wxLibraries wxTheLibraries; +// ============================================================================ +// 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 +// wxLibrary (one instance per dynamic library) // --------------------------------------------------------------------------- -wxLibrary::wxLibrary(void *handle) +wxLibrary::wxLibrary(wxDllType handle) { - typedef wxClassLibrary *(*t_get_list)(void); - t_get_list get_list; + typedef wxClassInfo *(*t_get_first)(void); + t_get_first get_first; - m_handle = handle; + m_handle = handle; - get_list = (t_get_list)GetSymbol("GetClassList"); - m_liblist = (*get_list)(); + // 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) { - typedef void (*t_free_list)(wxClassLibrary *); - t_free_list free_list; + if ( m_handle ) + { + wxDllClose(m_handle); + } +} - free_list = (t_free_list) GetSymbol("FreeClassList"); - if (free_list != NULL) - free_list(m_liblist); - else - delete m_liblist; +wxObject *wxLibrary::CreateObject(const wxString& name) +{ + wxClassInfo *info = (wxClassInfo *)classTable.Get(name); + + if (!info) + return NULL; - dlclose(m_handle); - } + return info->CreateObject(); } -wxObject *wxLibrary::CreateObject(const wxString& name) +void wxLibrary::PrepareClasses(wxClassInfo *first) { - return m_liblist->CreateObject(name); + // 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; + } } void *wxLibrary::GetSymbol(const wxString& symbname) { -#ifdef linux - return dlsym(m_handle, symbname.GetData()); -#endif + return wxDllLoader::GetSymbol(m_handle, symbname); } // --------------------------------------------------------------------------- -// wxLibraries (only one instance should normally exist) +// wxDllLoader // --------------------------------------------------------------------------- -wxLibraries::wxLibraries() + +#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 } -wxLibraries::~wxLibraries() +/* static */ +wxDllType wxDllLoader::LoadLibrary(const wxString & libname, bool *success) { - wxNode *node = m_loaded.First(); + 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 ) + { + 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 - while (node) { - wxLibrary *lib = (wxLibrary *)node->Data(); - delete lib; + 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 + failed = TRUE; + wxLogSysError( msg, libname.c_str() ); +#endif + } + + if ( success ) + *success = !failed; - node = node->Next(); - } + return handle; } -wxLibrary *wxLibraries::LoadLibrary(const wxString& name) + +/* static */ +void wxDllLoader::UnloadLibrary(wxDllType handle) { - wxString lib_name = name; - wxNode *node; - wxLibrary *lib; + wxDllClose(handle); +} - if ( (node = m_loaded.Find(name.GetData())) ) - return ((wxLibrary *)node->Data()); +/* static */ +void *wxDllLoader::GetSymbol(wxDllType dllHandle, const wxString &name, bool *success) +{ + bool failed = FALSE; + void *symbol = 0; -#ifdef linux - lib_name.Prepend("./lib"); - lib_name += ".so"; +#if defined(__WXMAC__) && !defined(__UNIX__) + Ptr symAddress; + CFragSymbolClass symClass; + Str255 symName; - printf("lib_name = %s\n", WXSTRINGCAST lib_name); + wxMacStringToPascal( name.c_str() , symName ) ; - void *handle = dlopen(lib_name.GetData(), RTLD_LAZY); + if( FindSymbol( ((CFragConnectionID)dllHandle), symName, &symAddress, &symClass ) == noErr ) + symbol = (void *)symAddress; - printf("handle = %x\n", handle); - lib = new wxLibrary(handle); +#elif defined(__WXPM__) || defined(__EMX__) + wxDllGetSymbol(dllHandle, symbol); -#endif -#ifdef __WINDOWS__ - lib_name += ".dll"; +#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 +#ifdef __WXWINCE__ + symbol = (void *) wxDllGetSymbol(dllHandle, name.c_str()); +#else + symbol = (void *) wxDllGetSymbol(dllHandle, name.mb_str()); #endif - m_loaded.Append(name.GetData(), lib); - return lib; -} - -wxObject *wxLibraries::CreateObject(const wxString& path) -{ - wxNode *node = m_loaded.First(); - wxObject *obj; +#endif // OS + + if ( !symbol ) + { +#ifdef HAVE_DLERROR + const wxChar *err = dlerror(); + if( err ) + { + wxLogError(wxT("%s"), err); + } +#else + failed = TRUE; + wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"), + name.c_str()); +#endif + } - while (node) { - obj = ((wxLibrary *)node->Data())->CreateObject(path); - if (obj) - return obj; + if( success ) + *success = !failed; - node = node->Next(); - } - return NULL; + return symbol; } // --------------------------------------------------------------------------- -// wxClassLibrary (this class is used to access the internal class) +// wxLibraries (only one instance should normally exist) // --------------------------------------------------------------------------- -wxClassLibrary::wxClassLibrary(void) +wxLibraries::wxLibraries():m_loaded(wxKEY_STRING) { } -wxClassLibrary::~wxClassLibrary(void) +wxLibraries::~wxLibraries() { - uint i; + wxNode *node = m_loaded.First(); + + while (node) { + wxLibrary *lib = (wxLibrary *)node->Data(); + delete lib; - for (i=0;iNext(); + } } -void wxClassLibrary::RegisterClass(wxClassInfo *class_info, - const wxString& path) +wxLibrary *wxLibraries::LoadLibrary(const wxString& name) { - wxClassLibInfo *info = new wxClassLibInfo; + wxLibrary *lib; + wxClassInfo *old_sm_first; + wxNode *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 libname = ConstructLibraryName(name); + + bool success = FALSE; + wxDllType handle = wxDllLoader::LoadLibrary(libname, &success); + if(success) + { + lib = new wxLibrary(handle); + wxClassInfo::sm_first = old_sm_first; - info->class_info = class_info; - info->path = path; - m_list.Add(info); + m_loaded.Append(name.GetData(), lib); + } + else + lib = NULL; + return lib; } -void wxClassLibrary::UnregisterClass(wxClassInfo *class_info) +wxObject *wxLibraries::CreateObject(const wxString& path) { - uint i = 0; + wxNode *node = m_loaded.First(); + wxObject *obj; - while (i < m_list.Count()) { - if (m_list[i]->class_info == class_info) { - delete (m_list[i]); - m_list.Remove(i); - return; + while (node) { + obj = ((wxLibrary *)node->Data())->CreateObject(path); + if (obj) + return obj; + + node = node->Next(); } - i++; - } + return NULL; } -bool wxClassLibrary::CreateObjects(const wxString& path, - wxArrayClassInfo& objs) -{ - wxClassLibInfo *info; - uint i = 0; +#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 +#include - while (i < m_list.Count()) { - info = m_list[i]; - if (wxMatchWild(path, info->path)) - objs.Add(info->class_info); - i++; - } - return (i > 0); +static char dl_last_error[1024]; + +static +void TranslateError(const char *path, int number) +{ + 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); } -bool wxClassLibrary::FetchInfos(const wxString& path, - wxArrayClassLibInfo& infos) +const char *dlerror() { - wxClassLibInfo *info; - uint i = 0; + return dl_last_error; +} - while (i < m_list.Count()) { - info = m_list[i]; - if (wxMatchWild(path, info->path)) { - wxClassLibInfo *inf = new wxClassLibInfo; - *inf = *info; - infos.Add(inf); +void *dlopen(const char *path, int WXUNUSED(mode) /* mode is ignored */) +{ + int dyld_result; + NSObjectFileImage ofile; + NSModule handle = NULL; + + 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); } - i++; - } - return (i > 0); + + return handle; } -wxObject *wxClassLibrary::CreateObject(const wxString& path) +int dlclose(void *handle) { - wxClassLibInfo *info; - uint i = 0; + NSUnLinkModule( handle, NSUNLINKMODULE_OPTION_NONE); + return 0; +} - while (i < m_list.Count()) { - info = m_list[i]; - if (wxMatchWild(path, info->path)) - return info->class_info->CreateObject(); - i++; - } - return NULL; +void *dlsym(void *handle, const char *symbol) +{ + void *addr; + + NSSymbol nsSymbol = NSLookupSymbolInModule( handle , symbol ) ; + + if ( nsSymbol) + { + addr = NSAddressOfSymbol(nsSymbol); + } + else + { + addr = NULL; + } + return addr; } + +#endif // defined(__DARWIN__) && (wxUSE_DYNLIB_CLASS || wxUSE_DYNAMIC_LOADER)