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 license
  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 #include "wx/dynlib.h"
  33 #include "wx/filefn.h"
  34 #include "wx/intl.h"
  35 #include "wx/log.h"
  36 #include "wx/tokenzr.h"
  37
  38 // ----------------------------------------------------------------------------
  39 // conditional compilation
  40 // ----------------------------------------------------------------------------
  41
  42 #if defined(HAVE_DLOPEN)
  43 #   define wxDllOpen(lib)                dlopen(lib.fn_str(), RTLD_NOW/*RTLD_LAZY*/)
  44 #   define wxDllGetSymbol(handle, name)  dlsym(handle, name.mb_str())
  45 #   define wxDllClose                    dlclose
  46 #elif defined(HAVE_SHL_LOAD)
  47 #   define wxDllOpen(lib)                shl_load(lib.fn_str(), BIND_DEFERRED, 0)
  48 #   define wxDllClose      shl_unload
  49
  50     static inline void *wxDllGetSymbol(shl_t handle, const wxString& name)
  51     {
  52         void *sym;
  53         if ( shl_findsym(&handle, name.mb_str(), TYPE_UNDEFINED, &sym) == 0 )
  54             return sym;
  55         else
  56             return (void *)0;
  57     }
  58 #elif defined(__WINDOWS__)
  59 #   include <windows.h>
  60
  61     // using LoadLibraryEx under Win32 to avoid name clash with LoadLibrary
  62 #   ifdef __WIN32__
  63 #      define wxDllOpen(lib)                  ::LoadLibraryEx(lib, 0, 0)
  64 #   else   // Win16
  65 #      define wxDllOpen(lib)                  ::LoadLibrary(lib)
  66 #   endif  // Win32/16
  67 #   define wxDllGetSymbol(handle, name)    ::GetProcAddress(handle, name)
  68 #   define wxDllClose                      ::FreeLibrary
  69 #else
  70 #   error "Don't know how to load shared libraries on this platform."
  71 #endif // OS
  72
  73 // ---------------------------------------------------------------------------
  74 // Global variables
  75 // ---------------------------------------------------------------------------
  76
  77 wxLibraries wxTheLibraries;
  78
  79 // ----------------------------------------------------------------------------
  80 // private functions
  81 // ----------------------------------------------------------------------------
  82
  83 // construct the full name from the base shared object name: adds a .dll
  84 // suffix under Windows or .so under Unix
  85 static wxString ConstructLibraryName(const wxString& basename)
  86 {
  87     wxString fullname(basename);
  88
  89 #if defined(__UNIX__)
  90 #   if defined(__HPUX__)
  91         fullname << ".sl";
  92 #   else        //__HPUX__
  93         fullname << ".so";
  94 #   endif       //__HPUX__
  95 #elif defined(__WINDOWS__)
  96     fullname << ".dll";
  97 #endif
  98
  99     return fullname;
 100 }
 101
 102 // ============================================================================
 103 // implementation
 104 // ============================================================================
 105
 106
 107 // ---------------------------------------------------------------------------
 108 // wxLibrary (one instance per dynamic library)
 109 // ---------------------------------------------------------------------------
 110
 111 wxLibrary::wxLibrary(wxDllType handle)
 112 {
 113     typedef wxClassInfo *(*t_get_first)(void);
 114     t_get_first get_first;
 115
 116     m_handle = handle;
 117
 118     // Some system may use a local heap for library.
 119     get_first = (t_get_first)GetSymbol("wxGetClassFirst");
 120     // It is a wxWindows DLL.
 121     if (get_first)
 122         PrepareClasses(get_first());
 123 }
 124
 125 wxLibrary::~wxLibrary()
 126 {
 127     if ( m_handle )
 128     {
 129         wxDllClose(m_handle);
 130     }
 131 }
 132
 133 wxObject *wxLibrary::CreateObject(const wxString& name)
 134 {
 135     wxClassInfo *info = (wxClassInfo *)classTable.Get(name);
 136
 137     if (!info)
 138         return NULL;
 139
 140     return info->CreateObject();
 141 }
 142
 143 void wxLibrary::PrepareClasses(wxClassInfo *first)
 144 {
 145     // Index all class infos by their class name
 146     wxClassInfo *info = first;
 147     while (info)
 148     {
 149         if (info->m_className)
 150             classTable.Put(info->m_className, (wxObject *)info);
 151         info = info->GetNext();
 152     }
 153
 154     // Set base pointers for each wxClassInfo
 155     info = first;
 156     while (info)
 157     {
 158         if (info->GetBaseClassName1())
 159             info->m_baseInfo1 = (wxClassInfo *)classTable.Get(info->GetBaseClassName1());
 160         if (info->GetBaseClassName2())
 161             info->m_baseInfo2 = (wxClassInfo *)classTable.Get(info->GetBaseClassName2());
 162         info = info->m_next;
 163     }
 164 }
 165
 166 void *wxLibrary::GetSymbol(const wxString& symbname)
 167 {
 168    return wxDllLoader::GetSymbol(m_handle, symbname);
 169 }
 170
 171 // ---------------------------------------------------------------------------
 172 // wxDllLoader
 173 // ---------------------------------------------------------------------------
 174
 175 /* static */
 176 wxDllType
 177 wxDllLoader::GetProgramHandle(void)
 178 {
 179 #ifdef __UNIX__
 180     return dlopen(NULL, RTLD_NOW/*RTLD_LAZY*/);
 181 #else
 182     wxFAIL_MSG(_("This method is not implemented under Windows"));
 183
 184     return 0;
 185 #endif
 186 }
 187
 188 /* static */
 189 wxDllType
 190 wxDllLoader::LoadLibrary(const wxString & libname, bool *success)
 191 {
 192     wxDllType handle;
 193
 194 #if defined(__WXMAC__)
 195     FSSpec myFSSpec ;
 196     Ptr myMainAddr ;
 197     Str255      myErrName ;
 198
 199     wxMacPathToFSSpec( libname , &myFSSpec ) ;
 200     if (GetDiskFragment( &myFSSpec , 0 , kCFragGoesToEOF , "\p" , kPrivateCFragCopy , &handle , &myMainAddr ,
 201                 myErrName ) != noErr )
 202     {
 203         p2cstr( myErrName ) ;
 204         wxASSERT_MSG( 1 , (char*)myErrName ) ;
 205         return NULL ;
 206     }
 207 #else // !Mac
 208     handle = wxDllOpen(libname);
 209 #endif // OS
 210
 211     if ( !handle )
 212     {
 213         wxLogSysError(_("Failed to load shared library '%s'"), libname.c_str());
 214     }
 215
 216     if ( success )
 217     {
 218         *success = handle != 0;
 219     }
 220
 221     return handle;
 222 }
 223
 224
 225 /* static */
 226 void
 227 wxDllLoader::UnloadLibrary(wxDllType handle)
 228 {
 229    wxDllClose(handle);
 230 }
 231
 232 /* static */
 233 void *
 234 wxDllLoader::GetSymbol(wxDllType dllHandle, const wxString &name)
 235 {
 236     void *symbol = NULL;    // return value
 237
 238 #if defined( __WXMAC__ )
 239     Ptr symAddress ;
 240     CFragSymbolClass symClass ;
 241     Str255      symName ;
 242
 243     strcpy( (char*) symName , name ) ;
 244     c2pstr( (char*) symName ) ;
 245
 246     if ( FindSymbol( dllHandle , symName , &symAddress , &symClass ) == noErr )
 247         symbol = (void *)symAddress ;
 248 #else
 249     symbol = wxDllGetSymbol(dllHandle, name);
 250 #endif
 251
 252     if ( !symbol )
 253     {
 254         wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
 255                       name.c_str());
 256     }
 257     return symbol;
 258 }
 259
 260 // ---------------------------------------------------------------------------
 261 // wxLibraries (only one instance should normally exist)
 262 // ---------------------------------------------------------------------------
 263
 264 wxLibraries::wxLibraries()
 265 {
 266 }
 267
 268 wxLibraries::~wxLibraries()
 269 {
 270     wxNode *node = m_loaded.First();
 271
 272     while (node) {
 273         wxLibrary *lib = (wxLibrary *)node->Data();
 274         delete lib;
 275
 276         node = node->Next();
 277     }
 278 }
 279
 280 wxLibrary *wxLibraries::LoadLibrary(const wxString& name)
 281 {
 282     wxNode *node;
 283     wxLibrary *lib;
 284     wxClassInfo *old_sm_first;
 285
 286     if ( (node = m_loaded.Find(name.GetData())) )
 287         return ((wxLibrary *)node->Data());
 288
 289     // If DLL shares data, this is necessary.
 290     old_sm_first = wxClassInfo::sm_first;
 291     wxClassInfo::sm_first = NULL;
 292
 293     wxString libname = ConstructLibraryName(name);
 294
 295 /*
 296   Unix automatically builds that library name, at least for dlopen()
 297 */
 298 #if 0
 299 #if defined(__UNIX__)
 300     // found the first file in LD_LIBRARY_PATH with this name
 301     wxString libPath("/lib:/usr/lib"); // system path first
 302     const char *envLibPath = getenv("LD_LIBRARY_PATH");
 303     if ( envLibPath )
 304         libPath << ':' << envLibPath;
 305     wxStringTokenizer tokenizer(libPath, _T(':'));
 306     while ( tokenizer.HasMoreToken() )
 307     {
 308         wxString fullname(tokenizer.NextToken());
 309
 310         fullname << '/' << libname;
 311         if ( wxFileExists(fullname) )
 312         {
 313             libname = fullname;
 314
 315             // found the library
 316             break;
 317         }
 318     }
 319     //else: not found in the path, leave the name as is (secutiry risk?)
 320
 321 #endif // __UNIX__
 322 #endif
 323
 324     bool success = FALSE;
 325     wxDllType handle = wxDllLoader::LoadLibrary(libname, &success);
 326     if(success)
 327     {
 328        lib = new wxLibrary(handle);
 329        wxClassInfo::sm_first = old_sm_first;
 330        m_loaded.Append(name.GetData(), lib);
 331     }
 332     else
 333        lib = NULL;
 334     return lib;
 335 }
 336
 337 wxObject *wxLibraries::CreateObject(const wxString& path)
 338 {
 339     wxNode *node = m_loaded.First();
 340     wxObject *obj;
 341
 342     while (node) {
 343         obj = ((wxLibrary *)node->Data())->CreateObject(path);
 344         if (obj)
 345             return obj;
 346
 347         node = node->Next();
 348     }
 349     return NULL;
 350 }
 351
 352 #endif // wxUSE_DYNLIB_CLASS