src/common/dynlib.cpp

   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 #ifdef __GNUG__
  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/private.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(__UNIX__)
 157     #if defined(__HPUX__)
 158         const wxChar *wxDynamicLibrary::ms_dllext = _T(".sl");
 159     #else
 160         const wxChar *wxDynamicLibrary::ms_dllext = _T(".so");
 161     #endif
 162 #endif
 163
 164 wxDllType wxDynamicLibrary::GetProgramHandle()
 165 {
 166 #if defined( HAVE_DLOPEN ) && !defined(__EMX__)
 167    return dlopen(0, RTLD_LAZY);
 168 #elif defined (HAVE_SHL_LOAD)
 169    return PROG_HANDLE;
 170 #else
 171    wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2"));
 172    return 0;
 173 #endif
 174 }
 175
 176 bool wxDynamicLibrary::Load(wxString libname, int flags)
 177 {
 178     wxASSERT_MSG(m_handle == 0, _T("Library already loaded."));
 179
 180     // add the proper extension for the DLL ourselves unless told not to
 181     if ( !(flags & wxDL_VERBATIM) )
 182     {
 183         // and also check that the libname doesn't already have it
 184         wxString ext;
 185         wxFileName::SplitPath(libname, NULL, NULL, &ext);
 186         if ( ext.empty() )
 187         {
 188             libname += GetDllExt();
 189         }
 190     }
 191
 192     // different ways to load a shared library
 193     //
 194     // FIXME: should go to the platform-specific files!
 195 #if defined(__WXMAC__) && !defined(__DARWIN__)
 196     FSSpec      myFSSpec;
 197     Ptr         myMainAddr;
 198     Str255      myErrName;
 199
 200     wxMacFilename2FSSpec( libname , &myFSSpec );
 201
 202     if( GetDiskFragment( &myFSSpec,
 203                          0,
 204                          kCFragGoesToEOF,
 205                          "\p",
 206                          kPrivateCFragCopy,
 207                          &m_handle,
 208                          &myMainAddr,
 209                          myErrName ) != noErr )
 210     {
 211         p2cstr( myErrName );
 212         wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
 213                        libname.c_str(),
 214                        (char*)myErrName );
 215         m_handle = 0;
 216     }
 217
 218 #elif defined(__WXPM__) || defined(__EMX__)
 219     char    err[256] = "";
 220     DosLoadModule(err, sizeof(err), libname.c_str(), &m_handle);
 221
 222 #elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
 223
 224 #if defined(__VMS) || defined(__DARWIN__)
 225     m_handle = dlopen(libname.c_str(), 0);  // The second parameter is ignored
 226 #else // !__VMS  && !__DARWIN__
 227     int rtldFlags = 0;
 228
 229     if ( flags & wxDL_LAZY )
 230     {
 231         wxASSERT_MSG( (flags & wxDL_NOW) == 0,
 232                       _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") );
 233 #ifdef RTLD_LAZY
 234         rtldFlags |= RTLD_LAZY;
 235 #else
 236         wxLogDebug(_T("wxDL_LAZY is not supported on this platform"));
 237 #endif
 238     }
 239     else if ( flags & wxDL_NOW )
 240     {
 241 #ifdef RTLD_NOW
 242         rtldFlags |= RTLD_NOW;
 243 #else
 244         wxLogDebug(_T("wxDL_NOW is not supported on this platform"));
 245 #endif
 246     }
 247
 248     if ( flags & wxDL_GLOBAL )
 249     {
 250 #ifdef RTLD_GLOBAL
 251         rtldFlags |= RTLD_GLOBAL;
 252 #else
 253         wxLogDebug(_T("RTLD_GLOBAL is not supported on this platform."));
 254 #endif
 255     }
 256
 257     m_handle = dlopen(libname.fn_str(), rtldFlags);
 258 #endif  // __VMS || __DARWIN__ ?
 259
 260 #elif defined(HAVE_SHL_LOAD)
 261     int shlFlags = 0;
 262
 263     if( flags & wxDL_LAZY )
 264     {
 265         wxASSERT_MSG( (flags & wxDL_NOW) == 0,
 266                       _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") );
 267         shlFlags |= BIND_DEFERRED;
 268     }
 269     else if( flags & wxDL_NOW )
 270     {
 271         shlFlags |= BIND_IMMEDIATE;
 272     }
 273     m_handle = shl_load(libname.fn_str(), BIND_DEFERRED, 0);
 274
 275 #elif defined(__WINDOWS__)
 276     m_handle = ::LoadLibrary(libname.c_str());
 277 #else
 278     #error  "runtime shared lib support not implemented on this platform"
 279 #endif
 280
 281     if ( m_handle == 0 )
 282     {
 283         wxString msg(_("Failed to load shared library '%s'"));
 284 #if defined(HAVE_DLERROR) && !defined(__EMX__)
 285
 286 #if wxUSE_UNICODE
 287         wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() );
 288         const wxChar *err = buffer;
 289 #else
 290         const wxChar *err = dlerror();
 291 #endif
 292
 293         if( err )
 294             wxLogError( msg, err );
 295 #else
 296         wxLogSysError( msg, libname.c_str() );
 297 #endif
 298     }
 299
 300     return IsLoaded();
 301 }
 302
 303 void wxDynamicLibrary::Unload()
 304 {
 305     if( IsLoaded() )
 306     {
 307 #if defined(__WXPM__) || defined(__EMX__)
 308         DosFreeModule( m_handle );
 309 #elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
 310         dlclose( m_handle );
 311 #elif defined(HAVE_SHL_LOAD)
 312         shl_unload( m_handle );
 313 #elif defined(__WINDOWS__)
 314         ::FreeLibrary( m_handle );
 315 #elif defined(__WXMAC__) && !defined(__DARWIN__)
 316         CloseConnection( (CFragConnectionID*) &m_handle );
 317 #else
 318 #error  "runtime shared lib support not implemented"
 319 #endif
 320         m_handle = 0;
 321     }
 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 #if defined(__WXMAC__) && !defined(__DARWIN__)
 333     Ptr                 symAddress;
 334     CFragSymbolClass    symClass;
 335     Str255              symName;
 336 #if TARGET_CARBON
 337     c2pstrcpy( (StringPtr) symName, name );
 338 #else
 339     strcpy( (char *)symName, name );
 340     c2pstr( (char *)symName );
 341 #endif
 342     if( FindSymbol( dllHandle, symName, &symAddress, &symClass ) == noErr )
 343         symbol = (void *)symAddress;
 344
 345 #elif defined(__WXPM__) || defined(__EMX__)
 346     DosQueryProcAddr( m_handle, 1L, name.c_str(), (PFN*)symbol );
 347
 348 #elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
 349     symbol = dlsym( m_handle, name.fn_str() );
 350
 351 #elif defined(HAVE_SHL_LOAD)
 352     // use local variable since shl_findsym modifies the handle argument
 353     // to indicate where the symbol was found (GD)
 354     wxDllType the_handle = m_handle;
 355     if( shl_findsym( &the_handle, name.fn_str(), TYPE_UNDEFINED, &symbol ) != 0 )
 356         symbol = 0;
 357
 358 #elif defined(__WINDOWS__)
 359     symbol = (void*) ::GetProcAddress( m_handle, name.mb_str() );
 360
 361 #else
 362 #error  "runtime shared lib support not implemented"
 363 #endif
 364
 365     if ( !symbol )
 366     {
 367 #if defined(HAVE_DLERROR) && !defined(__EMX__)
 368
 369 #if wxUSE_UNICODE
 370         wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() );
 371         const wxChar *err = buffer;
 372 #else
 373         const wxChar *err = dlerror();
 374 #endif
 375
 376         if( err )
 377         {
 378             wxLogError(wxT("%s"), err);
 379         }
 380 #else
 381         failed = TRUE;
 382         wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
 383                       name.c_str());
 384 #endif
 385     }
 386     if( success )
 387         *success = !failed;
 388
 389     return symbol;
 390 }
 391
 392
 393 /*static*/
 394 wxString
 395 wxDynamicLibrary::CanonicalizeName(const wxString& name,
 396                                    wxDynamicLibraryCategory
 397 #ifdef __UNIX__
 398                                         cat
 399 #else // !__UNIX__
 400                                         WXUNUSED(cat)
 401 #endif // __UNIX__/!__UNIX__
 402                                    )
 403 {
 404     wxString nameCanonic;
 405
 406     // under Unix the library names usualyl start with "lib" prefix, add it
 407 #ifdef __UNIX__
 408     switch ( cat )
 409     {
 410         default:
 411             wxFAIL_MSG( _T("unknown wxDynamicLibraryCategory value") );
 412             // fall through
 413
 414         case wxDL_MODULE:
 415             // don't do anything for modules, their names are arbitrary
 416             break;
 417
 418         case wxDL_LIBRARY:
 419             // library names should start with "lib" under Unix
 420             nameCanonic = _T("lib");
 421             break;
 422     }
 423 #endif // __UNIX__
 424
 425     nameCanonic << name << GetDllExt();
 426     return nameCanonic;
 427 }
 428
 429 /*static*/
 430 wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
 431                                                   wxPluginCategory cat)
 432 {
 433     wxString suffix;
 434     if ( cat == wxDL_PLUGIN_GUI )
 435     {
 436         wxAppTraits *traits = wxAppConsole::GetInstance() ?
 437                               wxAppConsole::GetInstance()->GetTraits() : NULL;
 438         wxASSERT_MSG( traits,
 439                _("can't query for GUI plugins name in console applications") );
 440         suffix = traits->GetToolkitInfo().shortName;
 441     }
 442 #if wxUSE_UNICODE
 443     suffix << _T('u');
 444 #endif
 445 #ifdef __WXDEBUG__
 446     suffix << _T('d');
 447 #endif
 448
 449     if ( !suffix.empty() )
 450         suffix = wxString(_T("_")) + suffix;
 451
 452 #define WXSTRINGIZE(x)  #x
 453 #ifdef __UNIX__
 454     #if (wxMINOR_VERSION % 2) == 0
 455         #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y)
 456     #else
 457         #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y) "." WXSTRINGIZE(z)
 458     #endif
 459 #else
 460     #if (wxMINOR_VERSION % 2) == 0
 461         #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y)
 462     #else
 463         #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y) WXSTRINGIZE(z)
 464     #endif
 465 #endif
 466
 467     suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
 468                                            wxRELEASE_NUMBER));
 469 #undef wxDLLVER
 470 #undef WXSTRINGIZE
 471
 472     return CanonicalizeName(name + suffix, wxDL_MODULE);
 473 }
 474
 475 /*static*/
 476 wxString wxDynamicLibrary::GetPluginsDirectory()
 477 {
 478 #ifdef __UNIX__
 479     wxString format = wxGetInstallPrefix();
 480     format << wxFILE_SEP_PATH
 481            << wxT("lib") << wxFILE_SEP_PATH
 482            << wxT("wx") << wxFILE_SEP_PATH
 483            << wxT("%i.%i");
 484     wxString dir;
 485     dir.Printf(format.c_str(), wxMAJOR_VERSION, wxMINOR_VERSION);
 486     return dir;
 487 #else
 488     return wxEmptyString;
 489 #endif
 490 }
 491
 492
 493 #endif // wxUSE_DYNLIB_CLASS