1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Dynamic library management
4 // Author: Guilhem Lavaux
8 // Copyright: (c) Guilhem Lavaux
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 # pragma implementation "dynlib.h"
24 #include "wx/wxprec.h"
30 #if wxUSE_DYNLIB_CLASS && !wxUSE_DYNAMIC_LOADER
32 #if defined(__WINDOWS__)
33 #include "wx/msw/private.h"
36 #include "wx/dynlib.h"
37 #include "wx/filefn.h"
41 #if defined(__WXMAC__)
42 #include "wx/mac/private.h"
45 // ----------------------------------------------------------------------------
46 // conditional compilation
47 // ----------------------------------------------------------------------------
49 #if defined(__WXPM__) || defined(__EMX__)
52 # define wxDllOpen(error, lib, handle) DosLoadModule(error, sizeof(error), lib, &handle)
53 # define wxDllGetSymbol(handle, modaddr) DosQueryProcAddr(handle, 1L, NULL, (PFN*)modaddr)
54 # define wxDllClose(handle) DosFreeModule(handle)
55 #elif defined(HAVE_DLOPEN)
56 // note about dlopen() flags: we use RTLD_NOW to have more Windows-like
57 // behaviour (Win won't let you load a library with missing symbols) and
58 // RTLD_GLOBAL because it is needed sometimes and probably doesn't hurt
59 // otherwise. On True64-Unix RTLD_GLOBAL is not allowed and on VMS the
60 // second argument on dlopen is ignored.
62 # define wxDllOpen(lib) dlopen(lib.fn_str(), 0 )
63 #elif defined( __osf__ )
64 # define wxDllOpen(lib) dlopen(lib.fn_str(), RTLD_LAZY )
66 # define wxDllOpen(lib) dlopen(lib.fn_str(), RTLD_LAZY | RTLD_GLOBAL)
68 #define wxDllGetSymbol(handle, name) dlsym(handle, name)
69 # define wxDllClose dlclose
70 #elif defined(HAVE_SHL_LOAD)
71 # define wxDllOpen(lib) shl_load(lib.fn_str(), BIND_DEFERRED, 0)
72 # define wxDllClose shl_unload
74 static inline void *wxDllGetSymbol(shl_t handle
, const wxString
& name
)
77 if ( shl_findsym(&handle
, name
.mb_str(), TYPE_UNDEFINED
, &sym
) == 0 )
83 #elif defined(__DARWIN__)
85 * The dlopen port is a port from dl_next.xs by Anno Siegel.
86 * dl_next.xs is itself a port from dl_dlopen.xs by Paul Marquess.
87 * The method used here is just to supply the sun style dlopen etc.
88 * functions in terms of Darwin NS*.
90 void *dlopen(const char *path
, int mode
/* mode is ignored */);
91 void *dlsym(void *handle
, const char *symbol
);
92 int dlclose(void *handle
);
93 const char *dlerror(void);
95 # define wxDllOpen(lib) dlopen(lib.fn_str(), 0)
96 # define wxDllGetSymbol(handle, name) dlsym(handle, name)
97 # define wxDllClose dlclose
98 #elif defined(__WINDOWS__)
99 // using LoadLibraryEx under Win32 to avoid name clash with LoadLibrary
102 # define wxDllOpen(lib) ::LoadLibraryExW(lib, 0, 0)
104 # define wxDllOpen(lib) ::LoadLibraryExA(lib, 0, 0)
107 # define wxDllOpen(lib) ::LoadLibrary(lib)
109 # define wxDllGetSymbol(handle, name) ::GetProcAddress(handle, name)
110 # define wxDllClose ::FreeLibrary
111 #elif defined(__WXMAC__)
112 # define wxDllClose(handle) CloseConnection(&((CFragConnectionID)handle))
114 # error "Don't know how to load shared libraries on this platform."
117 // ---------------------------------------------------------------------------
119 // ---------------------------------------------------------------------------
121 wxLibraries wxTheLibraries
;
123 // ============================================================================
125 // ============================================================================
127 // construct the full name from the base shared object name: adds a .dll
128 // suffix under Windows or .so under Unix
129 static wxString
ConstructLibraryName(const wxString
& basename
)
132 fullname
<< basename
<< wxDllLoader::GetDllExt();
137 // ---------------------------------------------------------------------------
138 // wxLibrary (one instance per dynamic library)
139 // ---------------------------------------------------------------------------
141 wxLibrary::wxLibrary(wxDllType handle
)
143 typedef wxClassInfo
*(*t_get_first
)(void);
144 t_get_first get_first
;
148 // Some system may use a local heap for library.
149 get_first
= (t_get_first
)GetSymbol("wxGetClassFirst");
150 // It is a wxWindows DLL.
152 PrepareClasses(get_first());
155 wxLibrary::~wxLibrary()
159 wxDllClose(m_handle
);
163 wxObject
*wxLibrary::CreateObject(const wxString
& name
)
165 wxClassInfo
*info
= (wxClassInfo
*)classTable
.Get(name
);
170 return info
->CreateObject();
173 void wxLibrary::PrepareClasses(wxClassInfo
*first
)
175 // Index all class infos by their class name
176 wxClassInfo
*info
= first
;
179 if (info
->m_className
)
180 classTable
.Put(info
->m_className
, (wxObject
*)info
);
184 // Set base pointers for each wxClassInfo
188 if (info
->GetBaseClassName1())
189 info
->m_baseInfo1
= (wxClassInfo
*)classTable
.Get(info
->GetBaseClassName1());
190 if (info
->GetBaseClassName2())
191 info
->m_baseInfo2
= (wxClassInfo
*)classTable
.Get(info
->GetBaseClassName2());
196 void *wxLibrary::GetSymbol(const wxString
& symbname
)
198 return wxDllLoader::GetSymbol(m_handle
, symbname
);
201 // ---------------------------------------------------------------------------
203 // ---------------------------------------------------------------------------
206 #if defined(__WINDOWS__) || defined(__WXPM__) || defined(__EMX__)
207 const wxString
wxDllLoader::ms_dllext( _T(".dll") );
208 #elif defined(__UNIX__)
209 #if defined(__HPUX__)
210 const wxString
wxDllLoader::ms_dllext( _T(".sl") );
212 const wxString
wxDllLoader::ms_dllext( _T(".so") );
214 #elif defined(__WXMAC__)
215 const wxString
wxDllLoader::ms_dllext( _T("") );
219 wxDllType
wxDllLoader::GetProgramHandle()
221 #if defined( HAVE_DLOPEN ) && !defined(__EMX__)
222 // optain handle for main program
223 return dlopen(NULL
, RTLD_NOW
/*RTLD_LAZY*/);
224 #elif defined (HAVE_SHL_LOAD)
225 // shl_findsymbol with NULL handle looks up in main program
228 wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2"));
234 wxDllType
wxDllLoader::LoadLibrary(const wxString
& libname
, bool *success
)
239 #if defined(__WXMAC__) && !defined(__UNIX__)
244 wxMacFilename2FSSpec( libname
, &myFSSpec
);
246 if( GetDiskFragment( &myFSSpec
,
251 &((CFragConnectionID
)handle
),
253 myErrName
) != noErr
)
256 wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
263 #elif defined(__WXPM__) || defined(__EMX__)
264 char zError
[256] = "";
265 wxDllOpen(zError
, libname
, handle
);
268 handle
= wxDllOpen(libname
);
274 wxString
msg(_("Failed to load shared library '%s'"));
277 const wxChar
*err
= dlerror();
281 wxLogError( msg
, err
);
285 wxLogSysError( msg
, libname
.c_str() );
297 void wxDllLoader::UnloadLibrary(wxDllType handle
)
303 void *wxDllLoader::GetSymbol(wxDllType dllHandle
, const wxString
&name
, bool *success
)
308 #if defined(__WXMAC__) && !defined(__UNIX__)
310 CFragSymbolClass symClass
;
314 c2pstrcpy( (StringPtr
) symName
, name
);
316 strcpy( (char *) symName
, name
);
317 c2pstr( (char *) symName
);
319 if( FindSymbol( ((CFragConnectionID
)dllHandle
), symName
, &symAddress
, &symClass
) == noErr
)
320 symbol
= (void *)symAddress
;
322 #elif defined(__WXPM__) || defined(__EMX__)
323 wxDllGetSymbol(dllHandle
, symbol
);
325 #else // Windows or Unix
327 // mb_str() is necessary in Unicode build
329 // "void *" cast is needed by gcc 3.1 + w32api 1.4, don't ask me why
330 symbol
= (void *)wxDllGetSymbol(dllHandle
, name
.mb_str());
337 const wxChar
*err
= dlerror();
341 wxLogError( msg
, err
);
342 wxLogError(_("Couldn't find symbol '%s' in a dynamic library"),
347 wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
358 // ---------------------------------------------------------------------------
359 // wxLibraries (only one instance should normally exist)
360 // ---------------------------------------------------------------------------
362 wxLibraries::wxLibraries():m_loaded(wxKEY_STRING
)
366 wxLibraries::~wxLibraries()
368 wxNode
*node
= m_loaded
.First();
371 wxLibrary
*lib
= (wxLibrary
*)node
->Data();
378 wxLibrary
*wxLibraries::LoadLibrary(const wxString
& name
)
381 wxClassInfo
*old_sm_first
;
382 wxNode
*node
= m_loaded
.Find(name
.GetData());
385 return ((wxLibrary
*)node
->Data());
387 // If DLL shares data, this is necessary.
388 old_sm_first
= wxClassInfo::sm_first
;
389 wxClassInfo::sm_first
= NULL
;
391 wxString libname
= ConstructLibraryName(name
);
393 bool success
= FALSE
;
394 wxDllType handle
= wxDllLoader::LoadLibrary(libname
, &success
);
397 lib
= new wxLibrary(handle
);
398 wxClassInfo::sm_first
= old_sm_first
;
400 m_loaded
.Append(name
.GetData(), lib
);
407 wxObject
*wxLibraries::CreateObject(const wxString
& path
)
409 wxNode
*node
= m_loaded
.First();
413 obj
= ((wxLibrary
*)node
->Data())->CreateObject(path
);
422 #endif // wxUSE_DYNLIB_CLASS && !wxUSE_DYNAMIC_LOADER
424 #if defined(__DARWIN__) && (wxUSE_DYNLIB_CLASS || wxUSE_DYNAMIC_LOADER)
425 // ---------------------------------------------------------------------------
426 // For Darwin/Mac OS X
427 // supply the sun style dlopen functions in terms of Darwin NS*
428 // ---------------------------------------------------------------------------
431 #include <mach-o/dyld.h>
433 static char dl_last_error
[1024];
436 void TranslateError(const char *path
, int number
)
439 static char *OFIErrorStrings
[] =
441 "%s(%d): Object Image Load Failure\n",
442 "%s(%d): Object Image Load Success\n",
443 "%s(%d): Not an recognisable object file\n",
444 "%s(%d): No valid architecture\n",
445 "%s(%d): Object image has an invalid format\n",
446 "%s(%d): Invalid access (permissions?)\n",
447 "%s(%d): Unknown error code from NSCreateObjectFileImageFromFile\n",
449 #define NUM_OFI_ERRORS (sizeof(OFIErrorStrings) / sizeof(OFIErrorStrings[0]))
452 if (index
> NUM_OFI_ERRORS
- 1) {
453 index
= NUM_OFI_ERRORS
- 1;
455 sprintf(dl_last_error
, OFIErrorStrings
[index
], path
, number
);
458 const char *dlerror()
460 return dl_last_error
;
463 void *dlopen(const char *path
, int WXUNUSED(mode
) /* mode is ignored */)
466 NSObjectFileImage ofile
;
467 NSModule handle
= NULL
;
469 dyld_result
= NSCreateObjectFileImageFromFile(path
, &ofile
);
470 if (dyld_result
!= NSObjectFileImageSuccess
)
472 TranslateError(path
, dyld_result
);
476 // NSLinkModule will cause the run to abort on any link error's
477 // not very friendly but the error recovery functionality is limited.
478 handle
= NSLinkModule(ofile
, path
, NSLINKMODULE_OPTION_BINDNOW
);
484 int dlclose(void *handle
)
486 NSUnLinkModule( handle
, NSUNLINKMODULE_OPTION_NONE
);
490 void *dlsym(void *WXUNUSED(handle
), const char *symbol
)
494 if (NSIsSymbolNameDefined(symbol
)) {
495 addr
= NSAddressOfSymbol(NSLookupAndBindSymbol(symbol
));
503 #endif // defined(__DARWIN__) && (wxUSE_DYNLIB_CLASS || wxUSE_DYNAMIC_LOADER)