Merge remote branch 'upstream/master' into pegasus

1 files changed, 414 insertions, 0 deletions

diff --git a/backends/taskbar/win32/win32-taskbar.cpp b/backends/taskbar/win32/win32-taskbar.cpp
new file mode 100644
index 0000000000..04889f3dd7
--- /dev/null
+++ b/backends/taskbar/win32/win32-taskbar.cpp
@@ -0,0 +1,414 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+// We cannot use common/scummsys.h directly as it will include
+// windows.h and we need to do it by hand to allow excluded functions
+#if defined(HAVE_CONFIG_H)
+#include "config.h"
+#endif
+
+#if defined(WIN32) && defined(USE_TASKBAR)
+
+// Needed for taskbar functions
+#if defined(__GNUC__)
+#ifdef __MINGW32__
+	#include "backends/taskbar/win32/mingw-compat.h"
+#else
+	#error Only compilation with MingW is supported
+#endif
+#else
+	// We need certain functions that are excluded by default
+	#undef NONLS
+	#undef NOICONS
+	#include <windows.h>
+	#if defined(ARRAYSIZE)
+		#undef ARRAYSIZE
+	#endif
+
+	// Default MSVC headers for ITaskbarList3 and IShellLink
+	#include <SDKDDKVer.h>
+#endif
+#include <shlobj.h>
+
+// For HWND
+#include <SDL_syswm.h>
+
+#include "common/scummsys.h"
+
+#include "backends/taskbar/win32/win32-taskbar.h"
+
+#include "common/config-manager.h"
+#include "common/textconsole.h"
+#include "common/file.h"
+
+// System.Title property key, values taken from http://msdn.microsoft.com/en-us/library/bb787584.aspx
+const PROPERTYKEY PKEY_Title = { /* fmtid = */ { 0xF29F85E0, 0x4FF9, 0x1068, { 0xAB, 0x91, 0x08, 0x00, 0x2B, 0x27, 0xB3, 0xD9 } }, /* propID = */ 2 };
+
+Win32TaskbarManager::Win32TaskbarManager() : _taskbar(NULL), _count(0), _icon(NULL) {
+	// Do nothing if not running on Windows 7 or later
+	if (!isWin7OrLater())
+		return;
+
+	CoInitialize(NULL);
+
+	// Try creating instance (on fail, _taskbar will contain NULL)
+	HRESULT hr = CoCreateInstance(CLSID_TaskbarList,
+	                              0,
+	                              CLSCTX_INPROC_SERVER,
+	                              IID_ITaskbarList3,
+	                              reinterpret_cast<void**> (&(_taskbar)));
+
+	if (SUCCEEDED(hr)) {
+		// Initialize taskbar object
+		if (FAILED(_taskbar->HrInit())) {
+			_taskbar->Release();
+			_taskbar = NULL;
+		}
+	} else {
+		warning("[Win32TaskbarManager::init] Cannot create taskbar instance");
+	}
+}
+
+Win32TaskbarManager::~Win32TaskbarManager() {
+	if (_taskbar)
+		_taskbar->Release();
+	_taskbar = NULL;
+
+	if (_icon)
+		DestroyIcon(_icon);
+
+	CoUninitialize();
+}
+
+void Win32TaskbarManager::setOverlayIcon(const Common::String &name, const Common::String &description) {
+	//warning("[Win32TaskbarManager::setOverlayIcon] Setting overlay icon to: %s (%s)", name.c_str(), description.c_str());
+
+	if (_taskbar == NULL)
+		return;
+
+	if (name.empty()) {
+		_taskbar->SetOverlayIcon(getHwnd(), NULL, L"");
+		return;
+	}
+
+	// Compute full icon path
+	Common::String path = getIconPath(name);
+	if (path.empty())
+		return;
+
+	HICON pIcon = (HICON)::LoadImage(NULL, path.c_str(), IMAGE_ICON, 16, 16, LR_LOADFROMFILE);
+	if (!pIcon) {
+		warning("[Win32TaskbarManager::setOverlayIcon] Cannot load icon!");
+		return;
+	}
+
+	// Sets the overlay icon
+	LPWSTR desc = ansiToUnicode(description.c_str());
+	_taskbar->SetOverlayIcon(getHwnd(), pIcon, desc);
+
+	DestroyIcon(pIcon);
+
+	delete[] desc;
+}
+
+void Win32TaskbarManager::setProgressValue(int completed, int total) {
+	if (_taskbar == NULL)
+		return;
+
+	_taskbar->SetProgressValue(getHwnd(), completed, total);
+}
+
+void Win32TaskbarManager::setProgressState(TaskbarProgressState state) {
+	if (_taskbar == NULL)
+		return;
+
+	_taskbar->SetProgressState(getHwnd(), (TBPFLAG)state);
+}
+
+void Win32TaskbarManager::setCount(int count) {
+	if (_taskbar == NULL)
+		return;
+
+	if (count == 0) {
+		_taskbar->SetOverlayIcon(getHwnd(), NULL, L"");
+		return;
+	}
+
+	// FIXME: This isn't really nice and could use a cleanup.
+	//        The only good thing is that it doesn't use GDI+
+	//        and thus does not have a dependancy on it,
+	//        with the downside of being a lot more ugly.
+	//        Maybe replace it by a Graphic::Surface, use
+	//        ScummVM font drawing and extract the contents at
+	//        the end?
+
+	if (_count != count || _icon == NULL) {
+		// Cleanup previous icon
+		_count = count;
+		if (_icon)
+			DestroyIcon(_icon);
+
+		Common::String countString = (count < 100 ? Common::String::format("%d", count) : "9+");
+
+		// Create transparent background
+		BITMAPV5HEADER bi;
+		ZeroMemory(&bi, sizeof(BITMAPV5HEADER));
+		bi.bV5Size        = sizeof(BITMAPV5HEADER);
+		bi.bV5Width       = 16;
+		bi.bV5Height      = 16;
+		bi.bV5Planes      = 1;
+		bi.bV5BitCount    = 32;
+		bi.bV5Compression = BI_RGB;
+		// Set 32 BPP alpha format
+		bi.bV5RedMask     = 0x00FF0000;
+		bi.bV5GreenMask   = 0x0000FF00;
+		bi.bV5BlueMask    = 0x000000FF;
+		bi.bV5AlphaMask   = 0xFF000000;
+
+		// Get DC
+		HDC hdc;
+		hdc = GetDC(NULL);
+		HDC hMemDC = CreateCompatibleDC(hdc);
+		ReleaseDC(NULL, hdc);
+
+		// Create a bitmap mask
+		HBITMAP hBitmapMask = CreateBitmap(16, 16, 1, 1, NULL);
+
+		// Create the DIB section with an alpha channel
+		void *lpBits;
+		HBITMAP hBitmap = CreateDIBSection(hdc, (BITMAPINFO *)&bi, DIB_RGB_COLORS, (void **)&lpBits, NULL, 0);
+		HBITMAP hOldBitmap = (HBITMAP)SelectObject(hMemDC, hBitmap);
+
+		// Load the icon background
+		HICON hIconBackground = LoadIcon(GetModuleHandle(NULL), MAKEINTRESOURCE(1002 /* IDI_COUNT */));
+		DrawIconEx(hMemDC, 0, 0, hIconBackground, 16, 16, 0, 0, DI_NORMAL);
+		DeleteObject(hIconBackground);
+
+		// Draw the count
+		LOGFONT lFont;
+		memset(&lFont, 0, sizeof(LOGFONT));
+		lFont.lfHeight = 10;
+		lFont.lfWeight = FW_BOLD;
+		lFont.lfItalic = 1;
+		strcpy(lFont.lfFaceName, "Arial");
+
+		HFONT hFont = CreateFontIndirect(&lFont);
+		SelectObject(hMemDC, hFont);
+
+		RECT rect;
+		SetRect(&rect, 4, 4, 12, 12);
+		SetTextColor(hMemDC, RGB(48, 48, 48));
+		SetBkMode(hMemDC, TRANSPARENT);
+		DrawText(hMemDC, countString.c_str(), -1, &rect, DT_NOCLIP|DT_CENTER);
+
+		// Set the text alpha to fully opaque (we consider the data inside the text rect)
+		DWORD *lpdwPixel = (DWORD *)lpBits;
+		for (int x = 3; x < 12; x++) {
+			for(int y = 3; y < 12; y++) {
+				unsigned char *p = (unsigned char *)(lpdwPixel + x * 16 + y);
+
+				if (p[0] != 0 && p[1] != 0 && p[2] != 0)
+					p[3] = 255;
+			}
+		}
+
+		// Cleanup DC
+		DeleteObject(hFont);
+		SelectObject(hMemDC, hOldBitmap);
+		DeleteDC(hMemDC);
+
+		// Prepare our new icon
+		ICONINFO ii;
+		ii.fIcon    = FALSE;
+		ii.xHotspot = 0;
+		ii.yHotspot = 0;
+		ii.hbmMask  = hBitmapMask;
+		ii.hbmColor = hBitmap;
+
+		_icon = CreateIconIndirect(&ii);
+
+		DeleteObject(hBitmap);
+		DeleteObject(hBitmapMask);
+
+		if (!_icon) {
+			warning("[Win32TaskbarManager::setCount] Cannot create icon for count");
+			return;
+		}
+	}
+
+	// Sets the overlay icon
+	LPWSTR desc = ansiToUnicode(Common::String::format("Found games: %d", count).c_str());
+	_taskbar->SetOverlayIcon(getHwnd(), _icon, desc);
+	delete[] desc;
+}
+
+void Win32TaskbarManager::addRecent(const Common::String &name, const Common::String &description) {
+	//warning("[Win32TaskbarManager::addRecent] Adding recent list entry: %s (%s)", name.c_str(), description.c_str());
+
+	if (_taskbar == NULL)
+		return;
+
+	// ANSI version doesn't seem to work correctly with Win7 jump lists, so explicitly use Unicode interface.
+	IShellLinkW *link;
+
+	// Get the ScummVM executable path.
+	WCHAR path[MAX_PATH];
+	GetModuleFileNameW(NULL, path, MAX_PATH);
+
+	// Create a shell link.
+	if (SUCCEEDED(CoCreateInstance(CLSID_ShellLink, NULL, CLSCTX_INPROC, IID_IShellLinkW, reinterpret_cast<void**> (&link)))) {
+		// Convert game name and description to Unicode.
+		LPWSTR game = ansiToUnicode(name.c_str());
+		LPWSTR desc = ansiToUnicode(description.c_str());
+
+		// Set link properties.
+		link->SetPath(path);
+		link->SetArguments(game);
+
+		Common::String iconPath = getIconPath(name);
+		if (iconPath.empty()) {
+			link->SetIconLocation(path, 0); // No game-specific icon available
+		} else {
+			LPWSTR icon = ansiToUnicode(iconPath.c_str());
+
+			link->SetIconLocation(icon, 0);
+
+			delete[] icon;
+		}
+
+		// The link's display name must be set via property store.
+		IPropertyStore* propStore;
+		HRESULT hr = link->QueryInterface(IID_IPropertyStore, reinterpret_cast<void**> (&(propStore)));
+		if (SUCCEEDED(hr)) {
+			PROPVARIANT pv;
+			pv.vt = VT_LPWSTR;
+			pv.pwszVal = desc;
+
+			hr = propStore->SetValue(PKEY_Title, pv);
+
+			propStore->Commit();
+			propStore->Release();
+		}
+
+		// SHAddToRecentDocs will cause the games to be added to the Recent list, allowing the user to pin them.
+		SHAddToRecentDocs(SHARD_LINK, link);
+		link->Release();
+		delete[] game;
+		delete[] desc;
+	}
+}
+
+Common::String Win32TaskbarManager::getIconPath(Common::String target) {
+	// We first try to look for a iconspath configuration variable then
+	// fallback to the extra path
+	//
+	// Icons can be either in a subfolder named "icons" or directly in the path
+
+	Common::String iconsPath = ConfMan.get("iconspath");
+	Common::String extraPath = ConfMan.get("extrapath");
+
+#define TRY_ICON_PATH(path) { \
+	Common::FSNode node((path)); \
+	if (node.exists()) \
+		return (path); \
+}
+
+	if (!iconsPath.empty()) {
+		TRY_ICON_PATH(iconsPath + "/" + target + ".ico");
+		TRY_ICON_PATH(iconsPath + "/" + ConfMan.get("gameid") + ".ico");
+		TRY_ICON_PATH(iconsPath + "/icons/" + target + ".ico");
+		TRY_ICON_PATH(iconsPath + "/icons/" + ConfMan.get("gameid") + ".ico");
+	}
+
+	if (!extraPath.empty()) {
+		TRY_ICON_PATH(extraPath + "/" + target + ".ico");
+		TRY_ICON_PATH(extraPath + "/" + ConfMan.get("gameid") + ".ico");
+		TRY_ICON_PATH(extraPath + "/icons/" + target + ".ico");
+		TRY_ICON_PATH(extraPath + "/icons/" + ConfMan.get("gameid") + ".ico");
+	}
+
+	return "";
+}
+
+// VerSetConditionMask and VerifyVersionInfo didn't appear until Windows 2000,
+// so we need to check for them at runtime
+LONGLONG VerSetConditionMaskFunc(ULONGLONG dwlConditionMask, DWORD dwTypeMask, BYTE dwConditionMask) {
+	typedef BOOL (WINAPI *VerSetConditionMaskFunction)(ULONGLONG conditionMask, DWORD typeMask, BYTE conditionOperator);
+
+	VerSetConditionMaskFunction verSetConditionMask = (VerSetConditionMaskFunction)GetProcAddress(GetModuleHandle(TEXT("kernel32.dll")), "VerSetConditionMask");
+	if (verSetConditionMask == NULL)
+		return 0;
+
+	return verSetConditionMask(dwlConditionMask, dwTypeMask, dwConditionMask);
+}
+
+BOOL VerifyVersionInfoFunc(LPOSVERSIONINFOEXA lpVersionInformation, DWORD dwTypeMask, DWORDLONG dwlConditionMask) {
+   typedef BOOL (WINAPI *VerifyVersionInfoFunction)(LPOSVERSIONINFOEXA versionInformation, DWORD typeMask, DWORDLONG conditionMask);
+
+   VerifyVersionInfoFunction verifyVersionInfo = (VerifyVersionInfoFunction)GetProcAddress(GetModuleHandle(TEXT("kernel32.dll")), "VerifyVersionInfoA");
+   if (verifyVersionInfo == NULL)
+      return FALSE;
+
+   return verifyVersionInfo(lpVersionInformation, dwTypeMask, dwlConditionMask);
+}
+
+bool Win32TaskbarManager::isWin7OrLater() {
+	OSVERSIONINFOEX versionInfo;
+	DWORDLONG conditionMask = 0;
+
+	ZeroMemory(&versionInfo, sizeof(OSVERSIONINFOEX));
+	versionInfo.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX);
+	versionInfo.dwMajorVersion = 6;
+	versionInfo.dwMinorVersion = 1;
+
+	conditionMask = VerSetConditionMaskFunc(conditionMask, VER_MAJORVERSION, VER_GREATER_EQUAL);
+	conditionMask = VerSetConditionMaskFunc(conditionMask, VER_MINORVERSION, VER_GREATER_EQUAL);
+
+	return VerifyVersionInfoFunc(&versionInfo, VER_MAJORVERSION | VER_MINORVERSION, conditionMask);
+}
+
+LPWSTR Win32TaskbarManager::ansiToUnicode(const char *s) {
+	DWORD size = MultiByteToWideChar(0, 0, s, -1, NULL, 0);
+
+	if (size > 0) {
+		LPWSTR result = new WCHAR[size];
+		if (MultiByteToWideChar(0, 0, s, -1, result, size) != 0)
+			return result;
+	}
+
+	return NULL;
+}
+
+HWND Win32TaskbarManager::getHwnd() {
+	SDL_SysWMinfo wmi;
+	SDL_VERSION(&wmi.version);
+
+	if(!SDL_GetWMInfo(&wmi))
+		return NULL;
+
+	return wmi.window;
+}
+
+#endif