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