]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/common/dynlib.cpp
removed an unused variable (patch 788101)
[wxWidgets.git] / src / common / dynlib.cpp
... / ...
CommitLineData
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/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
70static char dl_last_error[1024];
71
72static
73void 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
95const char *dlerror()
96{
97 return dl_last_error;
98}
99
100void *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
121int dlclose(void *handle)
122{
123 NSUnLinkModule( handle, NSUNLINKMODULE_OPTION_NONE);
124 return 0;
125}
126
127void *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
164wxDllType 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
176bool 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/* static */
304void wxDynamicLibrary::Unload(wxDllType handle)
305{
306#if defined(__WXPM__) || defined(__EMX__)
307 DosFreeModule( handle );
308#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
309 dlclose( handle );
310#elif defined(HAVE_SHL_LOAD)
311 shl_unload( handle );
312#elif defined(__WINDOWS__)
313 ::FreeLibrary( handle );
314#elif defined(__WXMAC__) && !defined(__DARWIN__)
315 CloseConnection( (CFragConnectionID*) &handle );
316#else
317 #error "runtime shared lib support not implemented"
318#endif
319}
320
321void *wxDynamicLibrary::GetSymbol(const wxString &name, bool *success) const
322{
323 wxCHECK_MSG( IsLoaded(), NULL,
324 _T("Can't load symbol from unloaded library") );
325
326 bool failed = FALSE;
327 void *symbol = 0;
328
329#if defined(__WXMAC__) && !defined(__DARWIN__)
330 Ptr symAddress;
331 CFragSymbolClass symClass;
332 Str255 symName;
333#if TARGET_CARBON
334 c2pstrcpy( (StringPtr) symName, name );
335#else
336 strcpy( (char *)symName, name );
337 c2pstr( (char *)symName );
338#endif
339 if( FindSymbol( dllHandle, symName, &symAddress, &symClass ) == noErr )
340 symbol = (void *)symAddress;
341
342#elif defined(__WXPM__) || defined(__EMX__)
343 DosQueryProcAddr( m_handle, 1L, name.c_str(), (PFN*)symbol );
344
345#elif defined(HAVE_DLOPEN) || defined(__DARWIN__)
346 symbol = dlsym( m_handle, name.fn_str() );
347
348#elif defined(HAVE_SHL_LOAD)
349 // use local variable since shl_findsym modifies the handle argument
350 // to indicate where the symbol was found (GD)
351 wxDllType the_handle = m_handle;
352 if( shl_findsym( &the_handle, name.fn_str(), TYPE_UNDEFINED, &symbol ) != 0 )
353 symbol = 0;
354
355#elif defined(__WINDOWS__)
356 symbol = (void*) ::GetProcAddress( m_handle, name.mb_str() );
357
358#else
359#error "runtime shared lib support not implemented"
360#endif
361
362 if ( !symbol )
363 {
364#if defined(HAVE_DLERROR) && !defined(__EMX__)
365
366#if wxUSE_UNICODE
367 wxWCharBuffer buffer = wxConvLocal.cMB2WC( dlerror() );
368 const wxChar *err = buffer;
369#else
370 const wxChar *err = dlerror();
371#endif
372
373 if( err )
374 {
375 wxLogError(wxT("%s"), err);
376 }
377#else
378 failed = TRUE;
379 wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
380 name.c_str());
381#endif
382 }
383 if( success )
384 *success = !failed;
385
386 return symbol;
387}
388
389
390/*static*/
391wxString
392wxDynamicLibrary::CanonicalizeName(const wxString& name,
393 wxDynamicLibraryCategory
394#ifdef __UNIX__
395 cat
396#else // !__UNIX__
397 WXUNUSED(cat)
398#endif // __UNIX__/!__UNIX__
399 )
400{
401 wxString nameCanonic;
402
403 // under Unix the library names usualyl start with "lib" prefix, add it
404#ifdef __UNIX__
405 switch ( cat )
406 {
407 default:
408 wxFAIL_MSG( _T("unknown wxDynamicLibraryCategory value") );
409 // fall through
410
411 case wxDL_MODULE:
412 // don't do anything for modules, their names are arbitrary
413 break;
414
415 case wxDL_LIBRARY:
416 // library names should start with "lib" under Unix
417 nameCanonic = _T("lib");
418 break;
419 }
420#endif // __UNIX__
421
422 nameCanonic << name << GetDllExt();
423 return nameCanonic;
424}
425
426/*static*/
427wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
428 wxPluginCategory cat)
429{
430 wxString suffix;
431 if ( cat == wxDL_PLUGIN_GUI )
432 {
433 wxAppTraits *traits = wxAppConsole::GetInstance() ?
434 wxAppConsole::GetInstance()->GetTraits() : NULL;
435 wxASSERT_MSG( traits,
436 _("can't query for GUI plugins name in console applications") );
437 suffix = traits->GetToolkitInfo().shortName;
438 }
439#if wxUSE_UNICODE
440 suffix << _T('u');
441#endif
442#ifdef __WXDEBUG__
443 suffix << _T('d');
444#endif
445
446 if ( !suffix.empty() )
447 suffix = wxString(_T("_")) + suffix;
448
449#define WXSTRINGIZE(x) #x
450#ifdef __UNIX__
451 #if (wxMINOR_VERSION % 2) == 0
452 #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y)
453 #else
454 #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y) "." WXSTRINGIZE(z)
455 #endif
456#else
457 #if (wxMINOR_VERSION % 2) == 0
458 #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y)
459 #else
460 #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y) WXSTRINGIZE(z)
461 #endif
462#endif
463
464 suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
465 wxRELEASE_NUMBER));
466#undef wxDLLVER
467#undef WXSTRINGIZE
468
469 return CanonicalizeName(name + suffix, wxDL_MODULE);
470}
471
472/*static*/
473wxString wxDynamicLibrary::GetPluginsDirectory()
474{
475#ifdef __UNIX__
476 wxString format = wxGetInstallPrefix();
477 format << wxFILE_SEP_PATH
478 << wxT("lib") << wxFILE_SEP_PATH
479 << wxT("wx") << wxFILE_SEP_PATH
480 << wxT("%i.%i");
481 wxString dir;
482 dir.Printf(format.c_str(), wxMAJOR_VERSION, wxMINOR_VERSION);
483 return dir;
484#else
485 return wxEmptyString;
486#endif
487}
488
489
490#endif // wxUSE_DYNLIB_CLASS