| 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 wxString 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 | // the declared type of the first EnumModulesProc() parameter changed in |
| 83 | // recent SDK versions and is no PCSTR instead of old PSTR, we know that |
| 84 | // it's const in version 11 and non-const in version 8 included with VC8 |
| 85 | // (and earlier), suppose that it's only changed in version 11 |
| 86 | #if defined(API_VERSION_NUMBER) && API_VERSION_NUMBER >= 11 |
| 87 | typedef PCSTR NameStr_t; |
| 88 | #else |
| 89 | typedef PSTR NameStr_t; |
| 90 | #endif |
| 91 | |
| 92 | // TODO: fix EnumerateLoadedModules() to use EnumerateLoadedModules64() |
| 93 | #ifdef __WIN64__ |
| 94 | typedef DWORD64 DWORD_32_64; |
| 95 | #else |
| 96 | typedef DWORD DWORD_32_64; |
| 97 | #endif |
| 98 | |
| 99 | static BOOL CALLBACK |
| 100 | EnumModulesProc(NameStr_t name, DWORD_32_64 base, ULONG size, void *data); |
| 101 | }; |
| 102 | |
| 103 | // ---------------------------------------------------------------------------- |
| 104 | // private functions |
| 105 | // ---------------------------------------------------------------------------- |
| 106 | |
| 107 | // return the module handle for the given base name |
| 108 | static |
| 109 | HMODULE wxGetModuleHandle(const char *name, void *addr) |
| 110 | { |
| 111 | // we want to use GetModuleHandleEx() instead of usual GetModuleHandle() |
| 112 | // because the former works correctly for comctl32.dll while the latter |
| 113 | // returns NULL when comctl32.dll version 6 is used under XP (note that |
| 114 | // GetModuleHandleEx() is only available under XP and later, coincidence?) |
| 115 | |
| 116 | // check if we can use GetModuleHandleEx |
| 117 | typedef BOOL (WINAPI *GetModuleHandleEx_t)(DWORD, LPCSTR, HMODULE *); |
| 118 | |
| 119 | static const GetModuleHandleEx_t INVALID_FUNC_PTR = (GetModuleHandleEx_t)-1; |
| 120 | |
| 121 | static GetModuleHandleEx_t s_pfnGetModuleHandleEx = INVALID_FUNC_PTR; |
| 122 | if ( s_pfnGetModuleHandleEx == INVALID_FUNC_PTR ) |
| 123 | { |
| 124 | wxDynamicLibrary dll(_T("kernel32.dll"), wxDL_VERBATIM); |
| 125 | s_pfnGetModuleHandleEx = |
| 126 | (GetModuleHandleEx_t)dll.RawGetSymbol(_T("GetModuleHandleExA")); |
| 127 | |
| 128 | // dll object can be destroyed, kernel32.dll won't be unloaded anyhow |
| 129 | } |
| 130 | |
| 131 | // get module handle from its address |
| 132 | if ( s_pfnGetModuleHandleEx ) |
| 133 | { |
| 134 | // flags are GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT | |
| 135 | // GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS |
| 136 | HMODULE hmod; |
| 137 | if ( s_pfnGetModuleHandleEx(6, (char *)addr, &hmod) && hmod ) |
| 138 | return hmod; |
| 139 | } |
| 140 | |
| 141 | // Windows CE only has Unicode API, so even we have an ANSI string here, we |
| 142 | // still need to use GetModuleHandleW() there |
| 143 | #ifdef __WXWINCE__ |
| 144 | return ::GetModuleHandleW(wxConvLibc.cMB2WC(name).data()); |
| 145 | #else |
| 146 | return ::GetModuleHandleA((char *)name); |
| 147 | #endif |
| 148 | } |
| 149 | |
| 150 | // ============================================================================ |
| 151 | // wxVersionDLL implementation |
| 152 | // ============================================================================ |
| 153 | |
| 154 | // ---------------------------------------------------------------------------- |
| 155 | // loading |
| 156 | // ---------------------------------------------------------------------------- |
| 157 | |
| 158 | wxVersionDLL::wxVersionDLL() |
| 159 | { |
| 160 | // don't give errors if DLL can't be loaded or used, we're prepared to |
| 161 | // handle it |
| 162 | wxLogNull noLog; |
| 163 | |
| 164 | if ( m_dll.Load(_T("version.dll"), wxDL_VERBATIM) ) |
| 165 | { |
| 166 | // the functions we load have either 'A' or 'W' suffix depending on |
| 167 | // whether we're in ANSI or Unicode build |
| 168 | #ifdef UNICODE |
| 169 | #define SUFFIX L"W" |
| 170 | #else // ANSI |
| 171 | #define SUFFIX "A" |
| 172 | #endif // UNICODE/ANSI |
| 173 | |
| 174 | #define LOAD_VER_FUNCTION(name) \ |
| 175 | m_pfn ## name = (name ## _t)m_dll.GetSymbol(_T(#name SUFFIX)); \ |
| 176 | if ( !m_pfn ## name ) \ |
| 177 | { \ |
| 178 | m_dll.Unload(); \ |
| 179 | return; \ |
| 180 | } |
| 181 | |
| 182 | DO_FOR_ALL_VER_FUNCS(LOAD_VER_FUNCTION); |
| 183 | |
| 184 | #undef LOAD_VER_FUNCTION |
| 185 | } |
| 186 | } |
| 187 | |
| 188 | // ---------------------------------------------------------------------------- |
| 189 | // wxVersionDLL operations |
| 190 | // ---------------------------------------------------------------------------- |
| 191 | |
| 192 | wxString wxVersionDLL::GetFileVersion(const wxString& filename) const |
| 193 | { |
| 194 | wxString ver; |
| 195 | if ( m_dll.IsLoaded() ) |
| 196 | { |
| 197 | wxChar *pc = wx_const_cast(wxChar *, filename.wx_str()); |
| 198 | |
| 199 | DWORD dummy; |
| 200 | DWORD sizeVerInfo = m_pfnGetFileVersionInfoSize(pc, &dummy); |
| 201 | if ( sizeVerInfo ) |
| 202 | { |
| 203 | wxCharBuffer buf(sizeVerInfo); |
| 204 | if ( m_pfnGetFileVersionInfo(pc, 0, sizeVerInfo, buf.data()) ) |
| 205 | { |
| 206 | void *pVer; |
| 207 | UINT sizeInfo; |
| 208 | if ( m_pfnVerQueryValue(buf.data(), _T("\\"), &pVer, &sizeInfo) ) |
| 209 | { |
| 210 | VS_FIXEDFILEINFO *info = (VS_FIXEDFILEINFO *)pVer; |
| 211 | ver.Printf(_T("%d.%d.%d.%d"), |
| 212 | HIWORD(info->dwFileVersionMS), |
| 213 | LOWORD(info->dwFileVersionMS), |
| 214 | HIWORD(info->dwFileVersionLS), |
| 215 | LOWORD(info->dwFileVersionLS)); |
| 216 | } |
| 217 | } |
| 218 | } |
| 219 | } |
| 220 | //else: we failed to load DLL, can't retrieve version info |
| 221 | |
| 222 | return ver; |
| 223 | } |
| 224 | |
| 225 | // ============================================================================ |
| 226 | // wxDynamicLibraryDetailsCreator implementation |
| 227 | // ============================================================================ |
| 228 | |
| 229 | /* static */ |
| 230 | BOOL CALLBACK |
| 231 | wxDynamicLibraryDetailsCreator::EnumModulesProc(NameStr_t name, |
| 232 | DWORD_32_64 base, |
| 233 | ULONG size, |
| 234 | void *data) |
| 235 | { |
| 236 | EnumModulesProcParams *params = (EnumModulesProcParams *)data; |
| 237 | |
| 238 | wxDynamicLibraryDetails *details = new wxDynamicLibraryDetails; |
| 239 | |
| 240 | // fill in simple properties |
| 241 | details->m_name = wxString::FromAscii(name); |
| 242 | details->m_address = wxUIntToPtr(base); |
| 243 | details->m_length = size; |
| 244 | |
| 245 | // to get the version, we first need the full path |
| 246 | HMODULE hmod = wxGetModuleHandle(name, details->m_address); |
| 247 | if ( hmod ) |
| 248 | { |
| 249 | wxString fullname = wxGetFullModuleName(hmod); |
| 250 | if ( !fullname.empty() ) |
| 251 | { |
| 252 | details->m_path = fullname; |
| 253 | details->m_version = params->verDLL->GetFileVersion(fullname); |
| 254 | } |
| 255 | } |
| 256 | |
| 257 | params->dlls->Add(details); |
| 258 | |
| 259 | // continue enumeration (returning FALSE would have stopped it) |
| 260 | return TRUE; |
| 261 | } |
| 262 | |
| 263 | // ============================================================================ |
| 264 | // wxDynamicLibrary implementation |
| 265 | // ============================================================================ |
| 266 | |
| 267 | // ---------------------------------------------------------------------------- |
| 268 | // misc functions |
| 269 | // ---------------------------------------------------------------------------- |
| 270 | |
| 271 | wxDllType wxDynamicLibrary::GetProgramHandle() |
| 272 | { |
| 273 | return (wxDllType)::GetModuleHandle(NULL); |
| 274 | } |
| 275 | |
| 276 | // ---------------------------------------------------------------------------- |
| 277 | // loading/unloading DLLs |
| 278 | // ---------------------------------------------------------------------------- |
| 279 | |
| 280 | /* static */ |
| 281 | wxDllType |
| 282 | wxDynamicLibrary::RawLoad(const wxString& libname, int WXUNUSED(flags)) |
| 283 | { |
| 284 | return ::LoadLibrary(libname.wx_str()); |
| 285 | } |
| 286 | |
| 287 | /* static */ |
| 288 | void wxDynamicLibrary::Unload(wxDllType handle) |
| 289 | { |
| 290 | ::FreeLibrary(handle); |
| 291 | } |
| 292 | |
| 293 | /* static */ |
| 294 | void *wxDynamicLibrary::RawGetSymbol(wxDllType handle, const wxString& name) |
| 295 | { |
| 296 | return (void *)::GetProcAddress(handle, |
| 297 | #ifdef __WXWINCE__ |
| 298 | name.c_str() |
| 299 | #else |
| 300 | name.ToAscii() |
| 301 | #endif // __WXWINCE__ |
| 302 | ); |
| 303 | } |
| 304 | |
| 305 | // ---------------------------------------------------------------------------- |
| 306 | // enumerating loaded DLLs |
| 307 | // ---------------------------------------------------------------------------- |
| 308 | |
| 309 | /* static */ |
| 310 | wxDynamicLibraryDetailsArray wxDynamicLibrary::ListLoaded() |
| 311 | { |
| 312 | wxDynamicLibraryDetailsArray dlls; |
| 313 | |
| 314 | #if wxUSE_DBGHELP |
| 315 | if ( wxDbgHelpDLL::Init() ) |
| 316 | { |
| 317 | // prepare to use functions for version info extraction |
| 318 | wxVersionDLL verDLL; |
| 319 | |
| 320 | wxDynamicLibraryDetailsCreator::EnumModulesProcParams params; |
| 321 | params.dlls = &dlls; |
| 322 | params.verDLL = &verDLL; |
| 323 | |
| 324 | if ( !wxDbgHelpDLL::EnumerateLoadedModules |
| 325 | ( |
| 326 | ::GetCurrentProcess(), |
| 327 | wxDynamicLibraryDetailsCreator::EnumModulesProc, |
| 328 | ¶ms |
| 329 | ) ) |
| 330 | { |
| 331 | wxLogLastError(_T("EnumerateLoadedModules")); |
| 332 | } |
| 333 | } |
| 334 | #endif // wxUSE_DBGHELP |
| 335 | |
| 336 | return dlls; |
| 337 | } |
| 338 | |
| 339 | #endif // wxUSE_DYNLIB_CLASS |
| 340 | |