| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: dynlib.cpp |
| 3 | // Purpose: Dynamic library management |
| 4 | // Author: Guilhem Lavaux |
| 5 | // Modified by: |
| 6 | // Created: 20/07/98 |
| 7 | // RCS-ID: $Id$ |
| 8 | // Copyright: (c) Guilhem Lavaux |
| 9 | // Licence: wxWindows licence |
| 10 | ///////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | // ============================================================================ |
| 13 | // declarations |
| 14 | // ============================================================================ |
| 15 | |
| 16 | // ---------------------------------------------------------------------------- |
| 17 | // headers |
| 18 | // ---------------------------------------------------------------------------- |
| 19 | |
| 20 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) |
| 21 | # pragma implementation "dynlib.h" |
| 22 | #endif |
| 23 | |
| 24 | #include "wx/wxprec.h" |
| 25 | |
| 26 | #ifdef __BORLANDC__ |
| 27 | #pragma hdrstop |
| 28 | #endif |
| 29 | |
| 30 | #if wxUSE_DYNLIB_CLASS |
| 31 | |
| 32 | #if defined(__WINDOWS__) |
| 33 | #include "wx/msw/wrapwin.h" |
| 34 | #endif |
| 35 | |
| 36 | #include "wx/dynlib.h" |
| 37 | #include "wx/filefn.h" |
| 38 | #include "wx/intl.h" |
| 39 | #include "wx/log.h" |
| 40 | #include "wx/utils.h" |
| 41 | #include "wx/filename.h" // for SplitPath() |
| 42 | #include "wx/app.h" |
| 43 | #include "wx/apptrait.h" |
| 44 | |
| 45 | #if defined(__WXMAC__) |
| 46 | #include "wx/mac/private.h" |
| 47 | #endif |
| 48 | |
| 49 | |
| 50 | // ============================================================================ |
| 51 | // implementation |
| 52 | // ============================================================================ |
| 53 | |
| 54 | #if defined(__DARWIN__) |
| 55 | // --------------------------------------------------------------------------- |
| 56 | // For Darwin/Mac OS X |
| 57 | // supply the sun style dlopen functions in terms of Darwin NS* |
| 58 | // --------------------------------------------------------------------------- |
| 59 | |
| 60 | /* Porting notes: |
| 61 | * The dlopen port is a port from dl_next.xs by Anno Siegel. |
| 62 | * dl_next.xs is itself a port from dl_dlopen.xs by Paul Marquess. |
| 63 | * The method used here is just to supply the sun style dlopen etc. |
| 64 | * functions in terms of Darwin NS*. |
| 65 | */ |
| 66 | |
| 67 | #include <stdio.h> |
| 68 | #include <mach-o/dyld.h> |
| 69 | |
| 70 | static char dl_last_error[1024]; |
| 71 | |
| 72 | static |
| 73 | void TranslateError(const char *path, int number) |
| 74 | { |
| 75 | unsigned int index; |
| 76 | static char *OFIErrorStrings[] = |
| 77 | { |
| 78 | "%s(%d): Object Image Load Failure\n", |
| 79 | "%s(%d): Object Image Load Success\n", |
| 80 | "%s(%d): Not an recognisable object file\n", |
| 81 | "%s(%d): No valid architecture\n", |
| 82 | "%s(%d): Object image has an invalid format\n", |
| 83 | "%s(%d): Invalid access (permissions?)\n", |
| 84 | "%s(%d): Unknown error code from NSCreateObjectFileImageFromFile\n", |
| 85 | }; |
| 86 | #define NUM_OFI_ERRORS (sizeof(OFIErrorStrings) / sizeof(OFIErrorStrings[0])) |
| 87 | |
| 88 | index = number; |
| 89 | if (index > NUM_OFI_ERRORS - 1) { |
| 90 | index = NUM_OFI_ERRORS - 1; |
| 91 | } |
| 92 | sprintf(dl_last_error, OFIErrorStrings[index], path, number); |
| 93 | } |
| 94 | |
| 95 | const char *dlerror() |
| 96 | { |
| 97 | return dl_last_error; |
| 98 | } |
| 99 | |
| 100 | void *dlopen(const char *path, int WXUNUSED(mode) /* mode is ignored */) |
| 101 | { |
| 102 | int dyld_result; |
| 103 | NSObjectFileImage ofile; |
| 104 | NSModule handle = NULL; |
| 105 | |
| 106 | dyld_result = NSCreateObjectFileImageFromFile(path, &ofile); |
| 107 | if (dyld_result != NSObjectFileImageSuccess) |
| 108 | { |
| 109 | TranslateError(path, dyld_result); |
| 110 | } |
| 111 | else |
| 112 | { |
| 113 | // NSLinkModule will cause the run to abort on any link error's |
| 114 | // not very friendly but the error recovery functionality is limited. |
| 115 | handle = NSLinkModule(ofile, path, NSLINKMODULE_OPTION_BINDNOW); |
| 116 | } |
| 117 | |
| 118 | return handle; |
| 119 | } |
| 120 | |
| 121 | int dlclose(void *handle) |
| 122 | { |
| 123 | NSUnLinkModule( handle, NSUNLINKMODULE_OPTION_NONE); |
| 124 | return 0; |
| 125 | } |
| 126 | |
| 127 | void *dlsym(void *handle, const char *symbol) |
| 128 | { |
| 129 | void *addr; |
| 130 | |
| 131 | NSSymbol nsSymbol = NSLookupSymbolInModule( handle , symbol ) ; |
| 132 | |
| 133 | if ( nsSymbol) |
| 134 | { |
| 135 | addr = NSAddressOfSymbol(nsSymbol); |
| 136 | } |
| 137 | else |
| 138 | { |
| 139 | addr = NULL; |
| 140 | } |
| 141 | return addr; |
| 142 | } |
| 143 | |
| 144 | #endif // defined(__DARWIN__) |
| 145 | |
| 146 | |
| 147 | // --------------------------------------------------------------------------- |
| 148 | // wxDynamicLibrary |
| 149 | // --------------------------------------------------------------------------- |
| 150 | |
| 151 | //FIXME: This class isn't really common at all, it should be moved into |
| 152 | // platform dependent files. |
| 153 | |
| 154 | #if defined(__WINDOWS__) || defined(__WXPM__) || defined(__EMX__) |
| 155 | const wxChar *wxDynamicLibrary::ms_dllext = _T(".dll"); |
| 156 | #elif defined(__WXMAC__) && !defined(__DARWIN__) |
| 157 | const wxChar *wxDynamicLibrary::ms_dllext = _T(""); |
| 158 | #elif defined(__UNIX__) |
| 159 | #if defined(__HPUX__) |
| 160 | const wxChar *wxDynamicLibrary::ms_dllext = _T(".sl"); |
| 161 | #elif defined(__DARWIN__) |
| 162 | const wxChar *wxDynamicLibrary::ms_dllext = _T(".dylib"); |
| 163 | #else |
| 164 | const wxChar *wxDynamicLibrary::ms_dllext = _T(".so"); |
| 165 | #endif |
| 166 | #endif |
| 167 | |
| 168 | wxDllType wxDynamicLibrary::GetProgramHandle() |
| 169 | { |
| 170 | #if defined( HAVE_DLOPEN ) && !defined(__EMX__) |
| 171 | return dlopen(0, RTLD_LAZY); |
| 172 | #elif defined (HAVE_SHL_LOAD) |
| 173 | return PROG_HANDLE; |
| 174 | #else |
| 175 | wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2")); |
| 176 | return 0; |
| 177 | #endif |
| 178 | } |
| 179 | |
| 180 | bool wxDynamicLibrary::Load(wxString libname, int flags) |
| 181 | { |
| 182 | wxASSERT_MSG(m_handle == 0, _T("Library already loaded.")); |
| 183 | |
| 184 | // add the proper extension for the DLL ourselves unless told not to |
| 185 | if ( !(flags & wxDL_VERBATIM) ) |
| 186 | { |
| 187 | // and also check that the libname doesn't already have it |
| 188 | wxString ext; |
| 189 | wxFileName::SplitPath(libname, NULL, NULL, &ext); |
| 190 | if ( ext.empty() ) |
| 191 | { |
| 192 | libname += GetDllExt(); |
| 193 | } |
| 194 | } |
| 195 | |
| 196 | // different ways to load a shared library |
| 197 | // |
| 198 | // FIXME: should go to the platform-specific files! |
| 199 | #if defined(__WXMAC__) && !defined(__DARWIN__) |
| 200 | FSSpec myFSSpec; |
| 201 | Ptr myMainAddr; |
| 202 | Str255 myErrName; |
| 203 | |
| 204 | wxMacFilename2FSSpec( libname , &myFSSpec ); |
| 205 | |
| 206 | if( GetDiskFragment( &myFSSpec, |
| 207 | 0, |
| 208 | kCFragGoesToEOF, |
| 209 | "\p", |
| 210 | kPrivateCFragCopy, |
| 211 | &m_handle, |
| 212 | &myMainAddr, |
| 213 | myErrName ) != noErr ) |
| 214 | { |
| 215 | wxLogSysError( _("Failed to load shared library '%s' Error '%s'"), |
| 216 | libname.c_str(), |
| 217 | wxMacMakeStringFromPascal( myErrName ).c_str() ); |
| 218 | m_handle = 0; |
| 219 | } |
| 220 | |
| 221 | #elif defined(__WXPM__) || defined(__EMX__) |
| 222 | char err[256] = ""; |
| 223 | DosLoadModule(err, sizeof(err), libname.c_str(), &m_handle); |
| 224 | |
| 225 | #elif defined(HAVE_DLOPEN) || defined(__DARWIN__) |
| 226 | |
| 227 | #if defined(__VMS) || defined(__DARWIN__) |
| 228 | m_handle = dlopen(libname.fn_str(), 0); // The second parameter is ignored |
| 229 | #else // !__VMS && !__DARWIN__ |
| 230 | int rtldFlags = 0; |
| 231 | |
| 232 | if ( flags & wxDL_LAZY ) |
| 233 | { |
| 234 | wxASSERT_MSG( (flags & wxDL_NOW) == 0, |
| 235 | _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") ); |
| 236 | #ifdef RTLD_LAZY |
| 237 | rtldFlags |= RTLD_LAZY; |
| 238 | #else |
| 239 | wxLogDebug(_T("wxDL_LAZY is not supported on this platform")); |
| 240 | #endif |
| 241 | } |
| 242 | else if ( flags & wxDL_NOW ) |
| 243 | { |
| 244 | #ifdef RTLD_NOW |
| 245 | rtldFlags |= RTLD_NOW; |
| 246 | #else |
| 247 | wxLogDebug(_T("wxDL_NOW is not supported on this platform")); |
| 248 | #endif |
| 249 | } |
| 250 | |
| 251 | if ( flags & wxDL_GLOBAL ) |
| 252 | { |
| 253 | #ifdef RTLD_GLOBAL |
| 254 | rtldFlags |= RTLD_GLOBAL; |
| 255 | #else |
| 256 | wxLogDebug(_T("RTLD_GLOBAL is not supported on this platform.")); |
| 257 | #endif |
| 258 | } |
| 259 | |
| 260 | m_handle = dlopen(libname.fn_str(), rtldFlags); |
| 261 | #endif // __VMS || __DARWIN__ ? |
| 262 | |
| 263 | #elif defined(HAVE_SHL_LOAD) |
| 264 | int shlFlags = 0; |
| 265 | |
| 266 | if( flags & wxDL_LAZY ) |
| 267 | { |
| 268 | wxASSERT_MSG( (flags & wxDL_NOW) == 0, |
| 269 | _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") ); |
| 270 | shlFlags |= BIND_DEFERRED; |
| 271 | } |
| 272 | else if( flags & wxDL_NOW ) |
| 273 | { |
| 274 | shlFlags |= BIND_IMMEDIATE; |
| 275 | } |
| 276 | m_handle = shl_load(libname.fn_str(), BIND_DEFERRED, 0); |
| 277 | |
| 278 | #elif defined(__WINDOWS__) |
| 279 | m_handle = ::LoadLibrary(libname.c_str()); |
| 280 | #else |
| 281 | #error "runtime shared lib support not implemented on this platform" |
| 282 | #endif |
| 283 | |
| 284 | if ( m_handle == 0 ) |
| 285 | { |
| 286 | wxString msg(_("Failed to load shared library '%s'")); |
| 287 | #if defined(HAVE_DLERROR) && !defined(__EMX__) |
| 288 | |
| 289 | #if wxUSE_UNICODE |
| 290 | wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() ); |
| 291 | const wxChar *err = buffer; |
| 292 | #else |
| 293 | const wxChar *err = dlerror(); |
| 294 | #endif |
| 295 | |
| 296 | if( err ) |
| 297 | wxLogError( msg, err ); |
| 298 | #else |
| 299 | wxLogSysError( msg, libname.c_str() ); |
| 300 | #endif |
| 301 | } |
| 302 | |
| 303 | return IsLoaded(); |
| 304 | } |
| 305 | |
| 306 | /* static */ |
| 307 | void wxDynamicLibrary::Unload(wxDllType handle) |
| 308 | { |
| 309 | #if defined(__WXPM__) || defined(__EMX__) |
| 310 | DosFreeModule( handle ); |
| 311 | #elif defined(HAVE_DLOPEN) || defined(__DARWIN__) |
| 312 | dlclose( handle ); |
| 313 | #elif defined(HAVE_SHL_LOAD) |
| 314 | shl_unload( handle ); |
| 315 | #elif defined(__WINDOWS__) |
| 316 | ::FreeLibrary( handle ); |
| 317 | #elif defined(__WXMAC__) && !defined(__DARWIN__) |
| 318 | CloseConnection( (CFragConnectionID*) &handle ); |
| 319 | #else |
| 320 | #error "runtime shared lib support not implemented" |
| 321 | #endif |
| 322 | } |
| 323 | |
| 324 | void *wxDynamicLibrary::GetSymbol(const wxString &name, bool *success) const |
| 325 | { |
| 326 | wxCHECK_MSG( IsLoaded(), NULL, |
| 327 | _T("Can't load symbol from unloaded library") ); |
| 328 | |
| 329 | bool failed = FALSE; |
| 330 | void *symbol = 0; |
| 331 | |
| 332 | wxUnusedVar(symbol); |
| 333 | #if defined(__WXMAC__) && !defined(__DARWIN__) |
| 334 | Ptr symAddress; |
| 335 | CFragSymbolClass symClass; |
| 336 | Str255 symName; |
| 337 | #if TARGET_CARBON |
| 338 | c2pstrcpy( (StringPtr) symName, name.fn_str() ); |
| 339 | #else |
| 340 | strcpy( (char *)symName, name.fn_str() ); |
| 341 | c2pstr( (char *)symName ); |
| 342 | #endif |
| 343 | if( FindSymbol( m_handle, symName, &symAddress, &symClass ) == noErr ) |
| 344 | symbol = (void *)symAddress; |
| 345 | |
| 346 | #elif defined(__WXPM__) || defined(__EMX__) |
| 347 | DosQueryProcAddr( m_handle, 1L, name.c_str(), (PFN*)symbol ); |
| 348 | |
| 349 | #elif defined(HAVE_DLOPEN) || defined(__DARWIN__) |
| 350 | symbol = dlsym( m_handle, name.fn_str() ); |
| 351 | |
| 352 | #elif defined(HAVE_SHL_LOAD) |
| 353 | // use local variable since shl_findsym modifies the handle argument |
| 354 | // to indicate where the symbol was found (GD) |
| 355 | wxDllType the_handle = m_handle; |
| 356 | if( shl_findsym( &the_handle, name.fn_str(), TYPE_UNDEFINED, &symbol ) != 0 ) |
| 357 | symbol = 0; |
| 358 | |
| 359 | #elif defined(__WINDOWS__) |
| 360 | #ifdef __WXWINCE__ |
| 361 | symbol = (void*) ::GetProcAddress( m_handle, name ); |
| 362 | #else |
| 363 | symbol = (void*) ::GetProcAddress( m_handle, name.mb_str() ); |
| 364 | #endif |
| 365 | |
| 366 | #else |
| 367 | #error "runtime shared lib support not implemented" |
| 368 | #endif |
| 369 | |
| 370 | if ( !symbol ) |
| 371 | { |
| 372 | #if defined(HAVE_DLERROR) && !defined(__EMX__) |
| 373 | |
| 374 | #if wxUSE_UNICODE |
| 375 | wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() ); |
| 376 | const wxChar *err = buffer; |
| 377 | #else |
| 378 | const wxChar *err = dlerror(); |
| 379 | #endif |
| 380 | |
| 381 | if( err ) |
| 382 | { |
| 383 | wxLogError(wxT("%s"), err); |
| 384 | } |
| 385 | #else |
| 386 | failed = TRUE; |
| 387 | wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"), |
| 388 | name.c_str()); |
| 389 | #endif |
| 390 | } |
| 391 | if( success ) |
| 392 | *success = !failed; |
| 393 | |
| 394 | return symbol; |
| 395 | } |
| 396 | |
| 397 | |
| 398 | /*static*/ |
| 399 | wxString |
| 400 | wxDynamicLibrary::CanonicalizeName(const wxString& name, |
| 401 | wxDynamicLibraryCategory |
| 402 | #ifdef __UNIX__ |
| 403 | cat |
| 404 | #else // !__UNIX__ |
| 405 | WXUNUSED(cat) |
| 406 | #endif // __UNIX__/!__UNIX__ |
| 407 | ) |
| 408 | { |
| 409 | wxString nameCanonic; |
| 410 | |
| 411 | // under Unix the library names usually start with "lib" prefix, add it |
| 412 | #ifdef __UNIX__ |
| 413 | switch ( cat ) |
| 414 | { |
| 415 | default: |
| 416 | wxFAIL_MSG( _T("unknown wxDynamicLibraryCategory value") ); |
| 417 | // fall through |
| 418 | |
| 419 | case wxDL_MODULE: |
| 420 | // don't do anything for modules, their names are arbitrary |
| 421 | break; |
| 422 | |
| 423 | case wxDL_LIBRARY: |
| 424 | // library names should start with "lib" under Unix |
| 425 | nameCanonic = _T("lib"); |
| 426 | break; |
| 427 | } |
| 428 | #endif // __UNIX__ |
| 429 | |
| 430 | nameCanonic << name << GetDllExt(); |
| 431 | return nameCanonic; |
| 432 | } |
| 433 | |
| 434 | /*static*/ |
| 435 | wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name, |
| 436 | wxPluginCategory cat) |
| 437 | { |
| 438 | wxString suffix; |
| 439 | if ( cat == wxDL_PLUGIN_GUI ) |
| 440 | { |
| 441 | wxAppTraits *traits = wxAppConsole::GetInstance() ? |
| 442 | wxAppConsole::GetInstance()->GetTraits() : NULL; |
| 443 | wxASSERT_MSG( traits, |
| 444 | _("can't query for GUI plugins name in console applications") ); |
| 445 | suffix = traits->GetToolkitInfo().shortName; |
| 446 | } |
| 447 | #if wxUSE_UNICODE |
| 448 | suffix << _T('u'); |
| 449 | #endif |
| 450 | #ifdef __WXDEBUG__ |
| 451 | suffix << _T('d'); |
| 452 | #endif |
| 453 | |
| 454 | if ( !suffix.empty() ) |
| 455 | suffix = wxString(_T("_")) + suffix; |
| 456 | |
| 457 | #define WXSTRINGIZE(x) #x |
| 458 | #ifdef __UNIX__ |
| 459 | #if (wxMINOR_VERSION % 2) == 0 |
| 460 | #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y) |
| 461 | #else |
| 462 | #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y) "." WXSTRINGIZE(z) |
| 463 | #endif |
| 464 | #else |
| 465 | #if (wxMINOR_VERSION % 2) == 0 |
| 466 | #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y) |
| 467 | #else |
| 468 | #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y) WXSTRINGIZE(z) |
| 469 | #endif |
| 470 | #endif |
| 471 | |
| 472 | suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION, |
| 473 | wxRELEASE_NUMBER)); |
| 474 | #undef wxDLLVER |
| 475 | #undef WXSTRINGIZE |
| 476 | |
| 477 | #ifdef __WINDOWS__ |
| 478 | // Add compiler identification: |
| 479 | #if defined(__GNUG__) |
| 480 | suffix << _T("_gcc"); |
| 481 | #elif defined(__VISUALC__) |
| 482 | suffix << _T("_vc"); |
| 483 | #elif defined(__WATCOMC__) |
| 484 | suffix << _T("_wat"); |
| 485 | #elif defined(__BORLANDC__) |
| 486 | suffix << _T("_bcc"); |
| 487 | #endif |
| 488 | #endif |
| 489 | |
| 490 | return CanonicalizeName(name + suffix, wxDL_MODULE); |
| 491 | } |
| 492 | |
| 493 | /*static*/ |
| 494 | wxString wxDynamicLibrary::GetPluginsDirectory() |
| 495 | { |
| 496 | #ifdef __UNIX__ |
| 497 | wxString format = wxGetInstallPrefix(); |
| 498 | wxString dir; |
| 499 | format << wxFILE_SEP_PATH |
| 500 | << wxT("lib") << wxFILE_SEP_PATH |
| 501 | << wxT("wx") << wxFILE_SEP_PATH |
| 502 | #if (wxMINOR_VERSION % 2) == 0 |
| 503 | << wxT("%i.%i"); |
| 504 | dir.Printf(format.c_str(), wxMAJOR_VERSION, wxMINOR_VERSION); |
| 505 | #else |
| 506 | << wxT("%i.%i.%i"); |
| 507 | dir.Printf(format.c_str(), |
| 508 | wxMAJOR_VERSION, wxMINOR_VERSION, wxRELEASE_NUMBER); |
| 509 | #endif |
| 510 | return dir; |
| 511 | |
| 512 | #else // ! __UNIX__ |
| 513 | return wxEmptyString; |
| 514 | #endif |
| 515 | } |
| 516 | |
| 517 | |
| 518 | #endif // wxUSE_DYNLIB_CLASS |