src/msw/dlmsw.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/dlmsw.cpp
   3 // Purpose:     Win32-specific part of wxDynamicLibrary and related classes
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     2005-01-10 (partly extracted from common/dynlib.cpp)
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998-2005 Vadim Zeitlin <vadim@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #include  "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23   #pragma hdrstop
  24 #endif
  25
  26 #if wxUSE_DYNLIB_CLASS
  27
  28 #include "wx/msw/private.h"
  29 #include "wx/msw/debughlp.h"
  30
  31 const wxChar *wxDynamicLibrary::ms_dllext = _T(".dll");
  32
  33 // ----------------------------------------------------------------------------
  34 // private classes
  35 // ----------------------------------------------------------------------------
  36
  37 // wrap some functions from version.dll: load them dynamically and provide a
  38 // clean interface
  39 class wxVersionDLL
  40 {
  41 public:
  42     // load version.dll and bind to its functions
  43     wxVersionDLL();
  44
  45     // return the file version as string, e.g. "x.y.z.w"
  46     wxString GetFileVersion(const wxString& filename) const;
  47
  48 private:
  49     typedef DWORD (APIENTRY *GetFileVersionInfoSize_t)(PTSTR, PDWORD);
  50     typedef BOOL (APIENTRY *GetFileVersionInfo_t)(PTSTR, DWORD, DWORD, PVOID);
  51     typedef BOOL (APIENTRY *VerQueryValue_t)(const PVOID, PTSTR, PVOID *, PUINT);
  52
  53     #define DO_FOR_ALL_VER_FUNCS(what)                                        \
  54         what(GetFileVersionInfoSize);                                         \
  55         what(GetFileVersionInfo);                                             \
  56         what(VerQueryValue)
  57
  58     #define DECLARE_VER_FUNCTION(func) func ## _t m_pfn ## func
  59
  60     DO_FOR_ALL_VER_FUNCS(DECLARE_VER_FUNCTION);
  61
  62     #undef DECLARE_VER_FUNCTION
  63
  64
  65     wxDynamicLibrary m_dll;
  66
  67
  68     DECLARE_NO_COPY_CLASS(wxVersionDLL)
  69 };
  70
  71 // class used to create wxDynamicLibraryDetails objects
  72 class WXDLLIMPEXP_BASE wxDynamicLibraryDetailsCreator
  73 {
  74 public:
  75     // type of parameters being passed to EnumModulesProc
  76     struct EnumModulesProcParams
  77     {
  78         wxDynamicLibraryDetailsArray *dlls;
  79         wxVersionDLL *verDLL;
  80     };
  81
  82     static BOOL CALLBACK
  83         EnumModulesProc(PSTR name, DWORD base, ULONG size, void *data);
  84 };
  85
  86 // ----------------------------------------------------------------------------
  87 // private functions
  88 // ----------------------------------------------------------------------------
  89
  90 // return the module handle for the given base name
  91 static
  92 HMODULE wxGetModuleHandle(const char *name, void *addr)
  93 {
  94     // we want to use GetModuleHandleEx() instead of usual GetModuleHandle()
  95     // because the former works correctly for comctl32.dll while the latter
  96     // returns NULL when comctl32.dll version 6 is used under XP (note that
  97     // GetModuleHandleEx() is only available under XP and later, coincidence?)
  98
  99     // check if we can use GetModuleHandleEx
 100     typedef BOOL (WINAPI *GetModuleHandleEx_t)(DWORD, LPCSTR, HMODULE *);
 101
 102     static const GetModuleHandleEx_t INVALID_FUNC_PTR = (GetModuleHandleEx_t)-1;
 103
 104     static GetModuleHandleEx_t s_pfnGetModuleHandleEx = INVALID_FUNC_PTR;
 105     if ( s_pfnGetModuleHandleEx == INVALID_FUNC_PTR )
 106     {
 107         wxDynamicLibrary dll(_T("kernel32.dll"), wxDL_VERBATIM);
 108         s_pfnGetModuleHandleEx =
 109             (GetModuleHandleEx_t)dll.RawGetSymbol(_T("GetModuleHandleExA"));
 110
 111         // dll object can be destroyed, kernel32.dll won't be unloaded anyhow
 112     }
 113
 114     // get module handle from its address
 115     if ( s_pfnGetModuleHandleEx )
 116     {
 117         // flags are GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT |
 118         //           GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
 119         HMODULE hmod;
 120         if ( s_pfnGetModuleHandleEx(6, (char *)addr, &hmod) && hmod )
 121             return hmod;
 122     }
 123
 124     // Windows CE only has Unicode API, so even we have an ANSI string here, we
 125     // still need to use GetModuleHandleW() there and so do it everywhere to
 126     // avoid #ifdefs -- this code is not performance-critical anyhow...
 127     return ::GetModuleHandle(wxString::FromAscii((char *)name));
 128 }
 129
 130 // ============================================================================
 131 // wxVersionDLL implementation
 132 // ============================================================================
 133
 134 // ----------------------------------------------------------------------------
 135 // loading
 136 // ----------------------------------------------------------------------------
 137
 138 wxVersionDLL::wxVersionDLL()
 139 {
 140     // don't give errors if DLL can't be loaded or used, we're prepared to
 141     // handle it
 142     wxLogNull noLog;
 143
 144     if ( m_dll.Load(_T("version.dll"), wxDL_VERBATIM) )
 145     {
 146         // the functions we load have either 'A' or 'W' suffix depending on
 147         // whether we're in ANSI or Unicode build
 148         #ifdef UNICODE
 149             #define SUFFIX L"W"
 150         #else // ANSI
 151             #define SUFFIX "A"
 152         #endif // UNICODE/ANSI
 153
 154         #define LOAD_VER_FUNCTION(name)                                       \
 155             m_pfn ## name = (name ## _t)m_dll.GetSymbol(_T(#name SUFFIX));    \
 156         if ( !m_pfn ## name )                                                 \
 157         {                                                                     \
 158             m_dll.Unload();                                                   \
 159             return;                                                           \
 160         }
 161
 162         DO_FOR_ALL_VER_FUNCS(LOAD_VER_FUNCTION);
 163
 164         #undef LOAD_VER_FUNCTION
 165     }
 166 }
 167
 168 // ----------------------------------------------------------------------------
 169 // wxVersionDLL operations
 170 // ----------------------------------------------------------------------------
 171
 172 wxString wxVersionDLL::GetFileVersion(const wxString& filename) const
 173 {
 174     wxString ver;
 175     if ( m_dll.IsLoaded() )
 176     {
 177         wxChar *pc = wx_const_cast(wxChar *, filename.c_str());
 178
 179         DWORD dummy;
 180         DWORD sizeVerInfo = m_pfnGetFileVersionInfoSize(pc, &dummy);
 181         if ( sizeVerInfo )
 182         {
 183             wxCharBuffer buf(sizeVerInfo);
 184             if ( m_pfnGetFileVersionInfo(pc, 0, sizeVerInfo, buf.data()) )
 185             {
 186                 void *pVer;
 187                 UINT sizeInfo;
 188                 if ( m_pfnVerQueryValue(buf.data(), _T("\\"), &pVer, &sizeInfo) )
 189                 {
 190                     VS_FIXEDFILEINFO *info = (VS_FIXEDFILEINFO *)pVer;
 191                     ver.Printf(_T("%d.%d.%d.%d"),
 192                                HIWORD(info->dwFileVersionMS),
 193                                LOWORD(info->dwFileVersionMS),
 194                                HIWORD(info->dwFileVersionLS),
 195                                LOWORD(info->dwFileVersionLS));
 196                 }
 197             }
 198         }
 199     }
 200     //else: we failed to load DLL, can't retrieve version info
 201
 202     return ver;
 203 }
 204
 205 // ============================================================================
 206 // wxDynamicLibraryDetailsCreator implementation
 207 // ============================================================================
 208
 209 /* static */
 210 BOOL CALLBACK
 211 wxDynamicLibraryDetailsCreator::EnumModulesProc(PSTR name,
 212                                                 DWORD base,
 213                                                 ULONG size,
 214                                                 void *data)
 215 {
 216     EnumModulesProcParams *params = (EnumModulesProcParams *)data;
 217
 218     wxDynamicLibraryDetails *details = new wxDynamicLibraryDetails;
 219
 220     // fill in simple properties
 221     details->m_name = wxString::FromAscii(name);
 222     details->m_address = wx_reinterpret_cast(void *, base);
 223     details->m_length = size;
 224
 225     // to get the version, we first need the full path
 226     HMODULE hmod = wxGetModuleHandle(name, (void *)base);
 227     if ( hmod )
 228     {
 229         wxString fullname = wxGetFullModuleName(hmod);
 230         if ( !fullname.empty() )
 231         {
 232             details->m_path = fullname;
 233             details->m_version = params->verDLL->GetFileVersion(fullname);
 234         }
 235     }
 236
 237     params->dlls->Add(details);
 238
 239     // continue enumeration (returning FALSE would have stopped it)
 240     return TRUE;
 241 }
 242
 243 // ============================================================================
 244 // wxDynamicLibrary implementation
 245 // ============================================================================
 246
 247 // ----------------------------------------------------------------------------
 248 // misc functions
 249 // ----------------------------------------------------------------------------
 250
 251 wxDllType wxDynamicLibrary::GetProgramHandle()
 252 {
 253     return (wxDllType)::GetModuleHandle(NULL);
 254 }
 255
 256 // ----------------------------------------------------------------------------
 257 // loading/unloading DLLs
 258 // ----------------------------------------------------------------------------
 259
 260 /* static */
 261 wxDllType
 262 wxDynamicLibrary::RawLoad(const wxString& libname, int WXUNUSED(flags))
 263 {
 264     return ::LoadLibrary(libname);
 265 }
 266
 267 /* static */
 268 void wxDynamicLibrary::Unload(wxDllType handle)
 269 {
 270     ::FreeLibrary(handle);
 271 }
 272
 273 /* static */
 274 void *wxDynamicLibrary::RawGetSymbol(wxDllType handle, const wxString& name)
 275 {
 276     return (void *)::GetProcAddress(handle,
 277 #ifdef __WXWINCE__
 278                                             name.c_str()
 279 #else
 280                                             name.ToAscii()
 281 #endif // __WXWINCE__
 282                                    );
 283 }
 284
 285 // ----------------------------------------------------------------------------
 286 // enumerating loaded DLLs
 287 // ----------------------------------------------------------------------------
 288
 289 /* static */
 290 wxDynamicLibraryDetailsArray wxDynamicLibrary::ListLoaded()
 291 {
 292     wxDynamicLibraryDetailsArray dlls;
 293
 294 #if wxUSE_DBGHELP
 295     if ( wxDbgHelpDLL::Init() )
 296     {
 297         // prepare to use functions for version info extraction
 298         wxVersionDLL verDLL;
 299
 300         wxDynamicLibraryDetailsCreator::EnumModulesProcParams params;
 301         params.dlls = &dlls;
 302         params.verDLL = &verDLL;
 303
 304         if ( !wxDbgHelpDLL::EnumerateLoadedModules
 305                             (
 306                                 ::GetCurrentProcess(),
 307                                 wxDynamicLibraryDetailsCreator::EnumModulesProc,
 308                                 &params
 309                             ) )
 310         {
 311             wxLogLastError(_T("EnumerateLoadedModules"));
 312         }
 313     }
 314 #endif // wxUSE_DBGHELP
 315
 316     return dlls;
 317 }
 318
 319 #endif // wxUSE_DYNLIB_CLASS
 320