1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Dynamic library management
4 // Author: Guilhem Lavaux
8 // Copyright: (c) Guilhem Lavaux
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 # pragma implementation "dynlib.h"
24 #include "wx/wxprec.h"
30 #if wxUSE_DYNLIB_CLASS
32 #if defined(__WINDOWS__)
33 #include "wx/msw/private.h"
36 #include "wx/dynlib.h"
37 #include "wx/filefn.h"
41 #include "wx/filename.h" // for SplitPath()
43 #include "wx/apptrait.h"
45 #if defined(__WXMAC__)
46 #include "wx/mac/private.h"
50 // ============================================================================
52 // ============================================================================
54 #if defined(__DARWIN__)
55 // ---------------------------------------------------------------------------
56 // For Darwin/Mac OS X
57 // supply the sun style dlopen functions in terms of Darwin NS*
58 // ---------------------------------------------------------------------------
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*.
68 #include <mach-o/dyld.h>
70 static char dl_last_error
[1024];
73 void TranslateError(const char *path
, int number
)
76 static char *OFIErrorStrings
[] =
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",
86 #define NUM_OFI_ERRORS (sizeof(OFIErrorStrings) / sizeof(OFIErrorStrings[0]))
89 if (index
> NUM_OFI_ERRORS
- 1) {
90 index
= NUM_OFI_ERRORS
- 1;
92 sprintf(dl_last_error
, OFIErrorStrings
[index
], path
, number
);
100 void *dlopen(const char *path
, int WXUNUSED(mode
) /* mode is ignored */)
103 NSObjectFileImage ofile
;
104 NSModule handle
= NULL
;
106 dyld_result
= NSCreateObjectFileImageFromFile(path
, &ofile
);
107 if (dyld_result
!= NSObjectFileImageSuccess
)
109 TranslateError(path
, dyld_result
);
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
);
121 int dlclose(void *handle
)
123 NSUnLinkModule( handle
, NSUNLINKMODULE_OPTION_NONE
);
127 void *dlsym(void *handle
, const char *symbol
)
131 NSSymbol nsSymbol
= NSLookupSymbolInModule( handle
, symbol
) ;
135 addr
= NSAddressOfSymbol(nsSymbol
);
144 #endif // defined(__DARWIN__)
147 // ---------------------------------------------------------------------------
149 // ---------------------------------------------------------------------------
151 //FIXME: This class isn't really common at all, it should be moved into
152 // platform dependent files.
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");
160 const wxChar
*wxDynamicLibrary::ms_dllext
= _T(".so");
164 wxDllType
wxDynamicLibrary::GetProgramHandle()
166 #if defined( HAVE_DLOPEN ) && !defined(__EMX__)
167 return dlopen(0, RTLD_LAZY
);
168 #elif defined (HAVE_SHL_LOAD)
171 wxFAIL_MSG( wxT("This method is not implemented under Windows or OS/2"));
176 bool wxDynamicLibrary::Load(wxString libname
, int flags
)
178 wxASSERT_MSG(m_handle
== 0, _T("Library already loaded."));
180 // add the proper extension for the DLL ourselves unless told not to
181 if ( !(flags
& wxDL_VERBATIM
) )
183 // and also check that the libname doesn't already have it
185 wxFileName::SplitPath(libname
, NULL
, NULL
, &ext
);
188 libname
+= GetDllExt();
192 // different ways to load a shared library
194 // FIXME: should go to the platform-specific files!
195 #if defined(__WXMAC__) && !defined(__DARWIN__)
200 wxMacFilename2FSSpec( libname
, &myFSSpec
);
202 if( GetDiskFragment( &myFSSpec
,
209 myErrName
) != noErr
)
212 wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
218 #elif defined(__WXPM__) || defined(__EMX__)
220 DosLoadModule(err
, sizeof(err
), libname
.c_str(), &m_handle
);
222 #elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
224 #if defined(__VMS) || defined(__DARWIN__)
225 m_handle
= dlopen(libname
.c_str(), 0); // The second parameter is ignored
226 #else // !__VMS && !__DARWIN__
229 if ( flags
& wxDL_LAZY
)
231 wxASSERT_MSG( (flags
& wxDL_NOW
) == 0,
232 _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") );
234 rtldFlags
|= RTLD_LAZY
;
236 wxLogDebug(_T("wxDL_LAZY is not supported on this platform"));
239 else if ( flags
& wxDL_NOW
)
242 rtldFlags
|= RTLD_NOW
;
244 wxLogDebug(_T("wxDL_NOW is not supported on this platform"));
248 if ( flags
& wxDL_GLOBAL
)
251 rtldFlags
|= RTLD_GLOBAL
;
253 wxLogDebug(_T("RTLD_GLOBAL is not supported on this platform."));
257 m_handle
= dlopen(libname
.fn_str(), rtldFlags
);
258 #endif // __VMS || __DARWIN__ ?
260 #elif defined(HAVE_SHL_LOAD)
263 if( flags
& wxDL_LAZY
)
265 wxASSERT_MSG( (flags
& wxDL_NOW
) == 0,
266 _T("wxDL_LAZY and wxDL_NOW are mutually exclusive.") );
267 shlFlags
|= BIND_DEFERRED
;
269 else if( flags
& wxDL_NOW
)
271 shlFlags
|= BIND_IMMEDIATE
;
273 m_handle
= shl_load(libname
.fn_str(), BIND_DEFERRED
, 0);
275 #elif defined(__WINDOWS__)
276 m_handle
= ::LoadLibrary(libname
.c_str());
278 #error "runtime shared lib support not implemented on this platform"
283 wxString
msg(_("Failed to load shared library '%s'"));
284 #if defined(HAVE_DLERROR) && !defined(__EMX__)
287 wxWCharBuffer buffer
= wxConvLocal
.cMB2WC( dlerror() );
288 const wxChar
*err
= buffer
;
290 const wxChar
*err
= dlerror();
294 wxLogError( msg
, err
);
296 wxLogSysError( msg
, libname
.c_str() );
303 /* static */ void wxDynamicLibrary::Unload(wxDllType handle
)
305 #if defined(__WXPM__) || defined(__EMX__)
306 DosFreeModule( handle
);
307 #elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
309 #elif defined(HAVE_SHL_LOAD)
310 shl_unload( handle
);
311 #elif defined(__WINDOWS__)
312 ::FreeLibrary( handle
);
313 #elif defined(__WXMAC__) && !defined(__DARWIN__)
314 CloseConnection( (CFragConnectionID
*) &handle
);
316 #error "runtime shared lib support not implemented"
320 void *wxDynamicLibrary::GetSymbol(const wxString
&name
, bool *success
) const
322 wxCHECK_MSG( IsLoaded(), NULL
,
323 _T("Can't load symbol from unloaded library") );
328 #if defined(__WXMAC__) && !defined(__DARWIN__)
330 CFragSymbolClass symClass
;
333 c2pstrcpy( (StringPtr
) symName
, name
);
335 strcpy( (char *)symName
, name
);
336 c2pstr( (char *)symName
);
338 if( FindSymbol( dllHandle
, symName
, &symAddress
, &symClass
) == noErr
)
339 symbol
= (void *)symAddress
;
341 #elif defined(__WXPM__) || defined(__EMX__)
342 DosQueryProcAddr( m_handle
, 1L, name
.c_str(), (PFN
*)symbol
);
344 #elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
345 symbol
= dlsym( m_handle
, name
.fn_str() );
347 #elif defined(HAVE_SHL_LOAD)
348 // use local variable since shl_findsym modifies the handle argument
349 // to indicate where the symbol was found (GD)
350 wxDllType the_handle
= m_handle
;
351 if( shl_findsym( &the_handle
, name
.fn_str(), TYPE_UNDEFINED
, &symbol
) != 0 )
354 #elif defined(__WINDOWS__)
355 symbol
= (void*) ::GetProcAddress( m_handle
, name
.mb_str() );
358 #error "runtime shared lib support not implemented"
363 #if defined(HAVE_DLERROR) && !defined(__EMX__)
366 wxWCharBuffer buffer
= wxConvLocal
.cMB2WC( dlerror() );
367 const wxChar
*err
= buffer
;
369 const wxChar
*err
= dlerror();
374 wxLogError(wxT("%s"), err
);
378 wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
391 wxDynamicLibrary::CanonicalizeName(const wxString
& name
,
392 wxDynamicLibraryCategory
397 #endif // __UNIX__/!__UNIX__
400 wxString nameCanonic
;
402 // under Unix the library names usualyl start with "lib" prefix, add it
407 wxFAIL_MSG( _T("unknown wxDynamicLibraryCategory value") );
411 // don't do anything for modules, their names are arbitrary
415 // library names should start with "lib" under Unix
416 nameCanonic
= _T("lib");
421 nameCanonic
<< name
<< GetDllExt();
426 wxString
wxDynamicLibrary::CanonicalizePluginName(const wxString
& name
,
427 wxPluginCategory cat
)
430 if ( cat
== wxDL_PLUGIN_GUI
)
432 wxAppTraits
*traits
= wxAppConsole::GetInstance() ?
433 wxAppConsole::GetInstance()->GetTraits() : NULL
;
434 wxASSERT_MSG( traits
,
435 _("can't query for GUI plugins name in console applications") );
436 suffix
= traits
->GetToolkitInfo().shortName
;
445 if ( !suffix
.empty() )
446 suffix
= wxString(_T("_")) + suffix
;
448 #define WXSTRINGIZE(x) #x
450 #if (wxMINOR_VERSION % 2) == 0
451 #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y)
453 #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y) "." WXSTRINGIZE(z)
456 #if (wxMINOR_VERSION % 2) == 0
457 #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y)
459 #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y) WXSTRINGIZE(z)
463 suffix
<< wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION
, wxMINOR_VERSION
,
468 return CanonicalizeName(name
+ suffix
, wxDL_MODULE
);
472 wxString
wxDynamicLibrary::GetPluginsDirectory()
475 wxString format
= wxGetInstallPrefix();
476 format
<< wxFILE_SEP_PATH
477 << wxT("lib") << wxFILE_SEP_PATH
478 << wxT("wx") << wxFILE_SEP_PATH
481 dir
.Printf(format
.c_str(), wxMAJOR_VERSION
, wxMINOR_VERSION
);
484 return wxEmptyString
;
489 #endif // wxUSE_DYNLIB_CLASS