src/common/dynlib.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:        src/common/dynlib.cpp
// Purpose:     Dynamic library management
// Author:      Guilhem Lavaux
// Modified by:
// Created:     20/07/98
// RCS-ID:      $Id: dynlib.cpp 41807 2006-10-09 15:58:56Z VZ $
// Copyright:   (c) 1998 Guilhem Lavaux
//                  2000-2005 Vadim Zeitlin
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

//FIXME:  This class isn't really common at all, it should be moved into
//        platform dependent files (already done for Windows and Unix)

// ============================================================================
// declarations
// ============================================================================

// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------

#include  "wx/wxprec.h"

#ifdef __BORLANDC__
    #pragma hdrstop
#endif

#if wxUSE_DYNLIB_CLASS

#include "wx/dynlib.h"

#ifndef WX_PRECOMP
    #include "wx/intl.h"
    #include "wx/log.h"
    #include "wx/app.h"
    #include "wx/utils.h"
#endif //WX_PRECOMP

#include "wx/filefn.h"
#include "wx/filename.h"        // for SplitPath()
#include "wx/platinfo.h"

#include "wx/arrimpl.cpp"

#if defined(__WXMAC__)
    #include "wx/mac/private.h"
#endif

WX_DEFINE_USER_EXPORTED_OBJARRAY(wxDynamicLibraryDetailsArray)

// ============================================================================
// implementation
// ============================================================================

// ---------------------------------------------------------------------------
// wxDynamicLibrary
// ---------------------------------------------------------------------------

#if defined(__WXPM__) || defined(__EMX__)
    const wxChar *wxDynamicLibrary::ms_dllext = _T(".dll");
#elif defined(__WXMAC__) && !defined(__DARWIN__)
    const wxChar *wxDynamicLibrary::ms_dllext = wxEmptyString;
#endif

// for MSW/Unix it is defined in platform-specific file
#if !(defined(__WXMSW__) || defined(__UNIX__)) || defined(__EMX__)

wxDllType wxDynamicLibrary::GetProgramHandle()
{
   wxFAIL_MSG( wxT("GetProgramHandle() is not implemented under this platform"));
   return 0;
}

#endif // __WXMSW__ || __UNIX__


bool wxDynamicLibrary::Load(const wxString& libnameOrig, int flags)
{
    wxASSERT_MSG(m_handle == 0, _T("Library already loaded."));

    // add the proper extension for the DLL ourselves unless told not to
    wxString libname = libnameOrig;
    if ( !(flags & wxDL_VERBATIM) )
    {
        // and also check that the libname doesn't already have it
        wxString ext;
        wxFileName::SplitPath(libname, NULL, NULL, &ext);
        if ( ext.empty() )
        {
            libname += GetDllExt();
        }
    }

    // different ways to load a shared library
    //
    // FIXME: should go to the platform-specific files!
#if defined(__WXMAC__) && !defined(__DARWIN__)
    FSSpec      myFSSpec;
    Ptr         myMainAddr;
    Str255      myErrName;

    wxMacFilename2FSSpec( libname , &myFSSpec );

    if( GetDiskFragment( &myFSSpec,
                         0,
                         kCFragGoesToEOF,
                         "\p",
                         kPrivateCFragCopy,
                         &m_handle,
                         &myMainAddr,
                         myErrName ) != noErr )
    {
        wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
                       libname.c_str(),
                       wxMacMakeStringFromPascal( myErrName ).c_str() );
        m_handle = 0;
    }

#elif defined(__WXPM__) || defined(__EMX__)
    char err[256] = "";
    DosLoadModule(err, sizeof(err), (PSZ)libname.c_str(), &m_handle);
#else // this should be the only remaining branch eventually
    m_handle = RawLoad(libname, flags);
#endif

    if ( m_handle == 0 )
    {
#ifdef wxHAVE_DYNLIB_ERROR
        Error();
#else
        wxLogSysError(_("Failed to load shared library '%s'"), libname.c_str());
#endif
    }

    return IsLoaded();
}

// for MSW and Unix this is implemented in the platform-specific file
//
// TODO: move the rest to os2/dlpm.cpp and mac/dlmac.cpp!
#if (!defined(__WXMSW__) && !defined(__UNIX__)) || defined(__EMX__)

/* static */
void wxDynamicLibrary::Unload(wxDllType handle)
{
#if defined(__OS2__) || defined(__EMX__)
    DosFreeModule( handle );
#elif defined(__WXMAC__) && !defined(__DARWIN__)
    CloseConnection( (CFragConnectionID*) &handle );
#else
    #error  "runtime shared lib support not implemented"
#endif
}

#endif // !(__WXMSW__ || __UNIX__)

void *wxDynamicLibrary::DoGetSymbol(const wxString &name, bool *success) const
{
    wxCHECK_MSG( IsLoaded(), NULL,
                 _T("Can't load symbol from unloaded library") );

    void    *symbol = 0;

    wxUnusedVar(symbol);
#if defined(__WXMAC__) && !defined(__DARWIN__)
    Ptr                 symAddress;
    CFragSymbolClass    symClass;
    Str255              symName;
#if TARGET_CARBON
    c2pstrcpy( (StringPtr) symName, name.fn_str() );
#else
    strcpy( (char *)symName, name.fn_str() );
    c2pstr( (char *)symName );
#endif
    if( FindSymbol( m_handle, symName, &symAddress, &symClass ) == noErr )
        symbol = (void *)symAddress;
#elif defined(__WXPM__) || defined(__EMX__)
    DosQueryProcAddr( m_handle, 1L, (PSZ)name.c_str(), (PFN*)symbol );
#else
    symbol = RawGetSymbol(m_handle, name);
#endif

    if ( success )
        *success = symbol != NULL;

    return symbol;
}

void *wxDynamicLibrary::GetSymbol(const wxString& name, bool *success) const
{
    void *symbol = DoGetSymbol(name, success);
    if ( !symbol )
    {
#ifdef wxHAVE_DYNLIB_ERROR
        Error();
#else
        wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
                      name.c_str());
#endif
    }

    return symbol;
}

// ----------------------------------------------------------------------------
// informational methods
// ----------------------------------------------------------------------------

/*static*/
wxString
wxDynamicLibrary::CanonicalizeName(const wxString& name,
                                   wxDynamicLibraryCategory cat)
{
    wxString nameCanonic;

    // under Unix the library names usually start with "lib" prefix, add it
#if defined(__UNIX__) && !defined(__EMX__)
    switch ( cat )
    {
        default:
            wxFAIL_MSG( _T("unknown wxDynamicLibraryCategory value") );
            // fall through

        case wxDL_MODULE:
            // don't do anything for modules, their names are arbitrary
            break;

        case wxDL_LIBRARY:
            // library names should start with "lib" under Unix
            nameCanonic = _T("lib");
            break;
    }
#else // !__UNIX__
    wxUnusedVar(cat);
#endif // __UNIX__/!__UNIX__

    nameCanonic << name << GetDllExt();
    return nameCanonic;
}

/*static*/
wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
                                                  wxPluginCategory cat)
{
    wxString suffix;
    if ( cat == wxDL_PLUGIN_GUI )
    {
        suffix = wxPlatformInfo::Get().GetPortIdShortName();
    }
#if wxUSE_UNICODE
    suffix << _T('u');
#endif
#ifdef __WXDEBUG__
    suffix << _T('d');
#endif

    if ( !suffix.empty() )
        suffix = wxString(_T("_")) + suffix;

#define WXSTRINGIZE(x)  #x
#if defined(__UNIX__) && !defined(__EMX__)
    #if (wxMINOR_VERSION % 2) == 0
        #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y)
    #else
        #define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y) "." WXSTRINGIZE(z)
    #endif
#else
    #if (wxMINOR_VERSION % 2) == 0
        #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y)
    #else
        #define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y) WXSTRINGIZE(z)
    #endif
#endif

    suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
                                           wxRELEASE_NUMBER));
#undef wxDLLVER
#undef WXSTRINGIZE

#ifdef __WINDOWS__
    // Add compiler identification:
    #if defined(__GNUG__)
        suffix << _T("_gcc");
    #elif defined(__VISUALC__)
        suffix << _T("_vc");
    #elif defined(__WATCOMC__)
        suffix << _T("_wat");
    #elif defined(__BORLANDC__)
        suffix << _T("_bcc");
    #endif
#endif

    return CanonicalizeName(name + suffix, wxDL_MODULE);
}

/*static*/
wxString wxDynamicLibrary::GetPluginsDirectory()
{
#ifdef __UNIX__
    wxString format = wxGetInstallPrefix();
    wxString dir;
    format << wxFILE_SEP_PATH
           << wxT("lib") << wxFILE_SEP_PATH
           << wxT("wx") << wxFILE_SEP_PATH
#if (wxMINOR_VERSION % 2) == 0
           << wxT("%i.%i");
    dir.Printf(format.c_str(), wxMAJOR_VERSION, wxMINOR_VERSION);
#else
           << wxT("%i.%i.%i");
    dir.Printf(format.c_str(),
               wxMAJOR_VERSION, wxMINOR_VERSION, wxRELEASE_NUMBER);
#endif
    return dir;

#else // ! __UNIX__
    return wxEmptyString;
#endif
}


#endif // wxUSE_DYNLIB_CLASS
1	william	31	/////////////////////////////////////////////////////////////////////////////
2			// Name: src/common/dynlib.cpp
3			// Purpose: Dynamic library management
4			// Author: Guilhem Lavaux
5			// Modified by:
6			// Created: 20/07/98
7			// RCS-ID: $Id: dynlib.cpp 41807 2006-10-09 15:58:56Z VZ $
8			// Copyright: (c) 1998 Guilhem Lavaux
9			// 2000-2005 Vadim Zeitlin
10			// Licence: wxWindows licence
11			/////////////////////////////////////////////////////////////////////////////
12
13			//FIXME: This class isn't really common at all, it should be moved into
14			// platform dependent files (already done for Windows and Unix)
15
16			// ============================================================================
17			// declarations
18			// ============================================================================
19
20			// ----------------------------------------------------------------------------
21			// headers
22			// ----------------------------------------------------------------------------
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
34			#ifndef WX_PRECOMP
35			#include "wx/intl.h"
36			#include "wx/log.h"
37			#include "wx/app.h"
38			#include "wx/utils.h"
39			#endif //WX_PRECOMP
40
41			#include "wx/filefn.h"
42			#include "wx/filename.h" // for SplitPath()
43			#include "wx/platinfo.h"
44
45			#include "wx/arrimpl.cpp"
46
47			#if defined(__WXMAC__)
48			#include "wx/mac/private.h"
49			#endif
50
51			WX_DEFINE_USER_EXPORTED_OBJARRAY(wxDynamicLibraryDetailsArray)
52
53			// ============================================================================
54			// implementation
55			// ============================================================================
56
57			// ---------------------------------------------------------------------------
58			// wxDynamicLibrary
59			// ---------------------------------------------------------------------------
60
61			#if defined(__WXPM__) \|\| defined(__EMX__)
62			const wxChar *wxDynamicLibrary::ms_dllext = _T(".dll");
63			#elif defined(__WXMAC__) && !defined(__DARWIN__)
64			const wxChar *wxDynamicLibrary::ms_dllext = wxEmptyString;
65			#endif
66
67			// for MSW/Unix it is defined in platform-specific file
68			#if !(defined(__WXMSW__) \|\| defined(__UNIX__)) \|\| defined(__EMX__)
69
70			wxDllType wxDynamicLibrary::GetProgramHandle()
71			{
72			wxFAIL_MSG( wxT("GetProgramHandle() is not implemented under this platform"));
73			return 0;
74			}
75
76			#endif // __WXMSW__ \|\| __UNIX__
77
78
79			bool wxDynamicLibrary::Load(const wxString& libnameOrig, int flags)
80			{
81			wxASSERT_MSG(m_handle == 0, _T("Library already loaded."));
82
83			// add the proper extension for the DLL ourselves unless told not to
84			wxString libname = libnameOrig;
85			if ( !(flags & wxDL_VERBATIM) )
86			{
87			// and also check that the libname doesn't already have it
88			wxString ext;
89			wxFileName::SplitPath(libname, NULL, NULL, &ext);
90			if ( ext.empty() )
91			{
92			libname += GetDllExt();
93			}
94			}
95
96			// different ways to load a shared library
97			//
98			// FIXME: should go to the platform-specific files!
99			#if defined(__WXMAC__) && !defined(__DARWIN__)
100			FSSpec myFSSpec;
101			Ptr myMainAddr;
102			Str255 myErrName;
103
104			wxMacFilename2FSSpec( libname , &myFSSpec );
105
106			if( GetDiskFragment( &myFSSpec,
107			0,
108			kCFragGoesToEOF,
109			"\p",
110			kPrivateCFragCopy,
111			&m_handle,
112			&myMainAddr,
113			myErrName ) != noErr )
114			{
115			wxLogSysError( _("Failed to load shared library '%s' Error '%s'"),
116			libname.c_str(),
117			wxMacMakeStringFromPascal( myErrName ).c_str() );
118			m_handle = 0;
119			}
120
121			#elif defined(__WXPM__) \|\| defined(__EMX__)
122			char err[256] = "";
123			DosLoadModule(err, sizeof(err), (PSZ)libname.c_str(), &m_handle);
124			#else // this should be the only remaining branch eventually
125			m_handle = RawLoad(libname, flags);
126			#endif
127
128			if ( m_handle == 0 )
129			{
130			#ifdef wxHAVE_DYNLIB_ERROR
131			Error();
132			#else
133			wxLogSysError(_("Failed to load shared library '%s'"), libname.c_str());
134			#endif
135			}
136
137			return IsLoaded();
138			}
139
140			// for MSW and Unix this is implemented in the platform-specific file
141			//
142			// TODO: move the rest to os2/dlpm.cpp and mac/dlmac.cpp!
143			#if (!defined(__WXMSW__) && !defined(__UNIX__)) \|\| defined(__EMX__)
144
145			/* static */
146			void wxDynamicLibrary::Unload(wxDllType handle)
147			{
148			#if defined(__OS2__) \|\| defined(__EMX__)
149			DosFreeModule( handle );
150			#elif defined(__WXMAC__) && !defined(__DARWIN__)
151			CloseConnection( (CFragConnectionID*) &handle );
152			#else
153			#error "runtime shared lib support not implemented"
154			#endif
155			}
156
157			#endif // !(__WXMSW__ \|\| __UNIX__)
158
159			void wxDynamicLibrary::DoGetSymbol(const wxString &name, bool success) const
160			{
161			wxCHECK_MSG( IsLoaded(), NULL,
162			_T("Can't load symbol from unloaded library") );
163
164			void *symbol = 0;
165
166			wxUnusedVar(symbol);
167			#if defined(__WXMAC__) && !defined(__DARWIN__)
168			Ptr symAddress;
169			CFragSymbolClass symClass;
170			Str255 symName;
171			#if TARGET_CARBON
172			c2pstrcpy( (StringPtr) symName, name.fn_str() );
173			#else
174			strcpy( (char *)symName, name.fn_str() );
175			c2pstr( (char *)symName );
176			#endif
177			if( FindSymbol( m_handle, symName, &symAddress, &symClass ) == noErr )
178			symbol = (void *)symAddress;
179			#elif defined(__WXPM__) \|\| defined(__EMX__)
180			DosQueryProcAddr( m_handle, 1L, (PSZ)name.c_str(), (PFN*)symbol );
181			#else
182			symbol = RawGetSymbol(m_handle, name);
183			#endif
184
185			if ( success )
186			*success = symbol != NULL;
187
188			return symbol;
189			}
190
191			void wxDynamicLibrary::GetSymbol(const wxString& name, bool success) const
192			{
193			void *symbol = DoGetSymbol(name, success);
194			if ( !symbol )
195			{
196			#ifdef wxHAVE_DYNLIB_ERROR
197			Error();
198			#else
199			wxLogSysError(_("Couldn't find symbol '%s' in a dynamic library"),
200			name.c_str());
201			#endif
202			}
203
204			return symbol;
205			}
206
207			// ----------------------------------------------------------------------------
208			// informational methods
209			// ----------------------------------------------------------------------------
210
211			/static/
212			wxString
213			wxDynamicLibrary::CanonicalizeName(const wxString& name,
214			wxDynamicLibraryCategory cat)
215			{
216			wxString nameCanonic;
217
218			// under Unix the library names usually start with "lib" prefix, add it
219			#if defined(__UNIX__) && !defined(__EMX__)
220			switch ( cat )
221			{
222			default:
223			wxFAIL_MSG( _T("unknown wxDynamicLibraryCategory value") );
224			// fall through
225
226			case wxDL_MODULE:
227			// don't do anything for modules, their names are arbitrary
228			break;
229
230			case wxDL_LIBRARY:
231			// library names should start with "lib" under Unix
232			nameCanonic = _T("lib");
233			break;
234			}
235			#else // !__UNIX__
236			wxUnusedVar(cat);
237			#endif // __UNIX__/!__UNIX__
238
239			nameCanonic << name << GetDllExt();
240			return nameCanonic;
241			}
242
243			/static/
244			wxString wxDynamicLibrary::CanonicalizePluginName(const wxString& name,
245			wxPluginCategory cat)
246			{
247			wxString suffix;
248			if ( cat == wxDL_PLUGIN_GUI )
249			{
250			suffix = wxPlatformInfo::Get().GetPortIdShortName();
251			}
252			#if wxUSE_UNICODE
253			suffix << _T('u');
254			#endif
255			#ifdef __WXDEBUG__
256			suffix << _T('d');
257			#endif
258
259			if ( !suffix.empty() )
260			suffix = wxString(_T("_")) + suffix;
261
262			#define WXSTRINGIZE(x) #x
263			#if defined(__UNIX__) && !defined(__EMX__)
264			#if (wxMINOR_VERSION % 2) == 0
265			#define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y)
266			#else
267			#define wxDLLVER(x,y,z) "-" WXSTRINGIZE(x) "." WXSTRINGIZE(y) "." WXSTRINGIZE(z)
268			#endif
269			#else
270			#if (wxMINOR_VERSION % 2) == 0
271			#define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y)
272			#else
273			#define wxDLLVER(x,y,z) WXSTRINGIZE(x) WXSTRINGIZE(y) WXSTRINGIZE(z)
274			#endif
275			#endif
276
277			suffix << wxString::FromAscii(wxDLLVER(wxMAJOR_VERSION, wxMINOR_VERSION,
278			wxRELEASE_NUMBER));
279			#undef wxDLLVER
280			#undef WXSTRINGIZE
281
282			#ifdef __WINDOWS__
283			// Add compiler identification:
284			#if defined(__GNUG__)
285			suffix << _T("_gcc");
286			#elif defined(__VISUALC__)
287			suffix << _T("_vc");
288			#elif defined(__WATCOMC__)
289			suffix << _T("_wat");
290			#elif defined(__BORLANDC__)
291			suffix << _T("_bcc");
292			#endif
293			#endif
294
295			return CanonicalizeName(name + suffix, wxDL_MODULE);
296			}
297
298			/static/
299			wxString wxDynamicLibrary::GetPluginsDirectory()
300			{
301			#ifdef __UNIX__
302			wxString format = wxGetInstallPrefix();
303			wxString dir;
304			format << wxFILE_SEP_PATH
305			<< wxT("lib") << wxFILE_SEP_PATH
306			<< wxT("wx") << wxFILE_SEP_PATH
307			#if (wxMINOR_VERSION % 2) == 0
308			<< wxT("%i.%i");
309			dir.Printf(format.c_str(), wxMAJOR_VERSION, wxMINOR_VERSION);
310			#else
311			<< wxT("%i.%i.%i");
312			dir.Printf(format.c_str(),
313			wxMAJOR_VERSION, wxMINOR_VERSION, wxRELEASE_NUMBER);
314			#endif
315			return dir;
316
317			#else // ! __UNIX__
318			return wxEmptyString;
319			#endif
320			}
321
322
323			#endif // wxUSE_DYNLIB_CLASS