Ticket #9267: jump_list.patch

backends/platform/sdl/win32/win32.cpp

@@ -26 +26 @@
 // Disable symbol overrides so that we can use system headers.
 #define FORBIDDEN_SYMBOL_ALLOW_ALL
 
-#include "common/scummsys.h"
-
 #ifdef WIN32
 
 #define WIN32_LEAN_AND_MEAN
+#include <SDKDDKVer.h>
 #include <windows.h>
+#include <shlobj.h>
 #undef ARRAYSIZE // winnt.h defines ARRAYSIZE, but we want our own one...
 
+
+#include "common/scummsys.h"
+#include "common/config-manager.h"
+
+
 #include "backends/platform/sdl/win32/win32.h"
 #include "backends/fs/windows/windows-fs-factory.h"
 
@@ -62 +67 @@
 
 #endif
 
+namespace // Internal linkage
+{
+
+// 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 };
+
+// Helper function to convert from ANSI to unicode strings. Caller must delete[] return value.
+LPWSTR ansiToUnicode(const char *s)
+{
+        DWORD size = MultiByteToWideChar(CP_ACP, 0, s, -1, NULL, 0);
+        if( size > 0 )
+        {
+                LPWSTR result = new WCHAR[size];
+                if( MultiByteToWideChar(CP_ACP, 0, s, -1, result, size) != 0 )
+                        return result;
+        }
+        return NULL;
+}
+
+bool isWin7OrLater() 
+{
+   OSVERSIONINFOEX versionInfo;
+   DWORDLONG conditionMask = 0;
+
+   ZeroMemory(&versionInfo, sizeof(OSVERSIONINFOEX));
+   versionInfo.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX);
+   versionInfo.dwMajorVersion = 6;
+   versionInfo.dwMinorVersion = 1;
+
+   VER_SET_CONDITION(conditionMask, VER_MAJORVERSION, VER_GREATER_EQUAL);
+   VER_SET_CONDITION(conditionMask, VER_MINORVERSION, VER_GREATER_EQUAL);
+
+   return VerifyVersionInfo(&versionInfo, VER_MAJORVERSION | VER_MINORVERSION, conditionMask);
+}
+
+}
+
 void OSystem_Win32::init() {
 #ifdef HIDE_CONSOLE
         // console hiding for win32
@@ -168 +210 @@
         }
 }
 
+void OSystem_Win32::engineInit()
+{
+        OSystem_SDL::engineInit();
+        
+        // Calling SHAddToRecentDocs with an IShellLink is only supported for jump list purposes in Windows 7,
+        // so we don't call it in older versions of Windows.
+        if (isWin7OrLater()) {
+                // 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_PPV_ARGS(&link)))) {
+                        // Convert game name and description to Unicode.
+                        LPWSTR game = ansiToUnicode(ConfMan.getActiveDomainName().c_str());
+                        LPWSTR description = ansiToUnicode(ConfMan.get("description").c_str());
+
+                        // Set link properties.
+                        link->SetPath(path);
+                        link->SetArguments(game);
+                        link->SetIconLocation(path, 0); // There's no way to get a game-specific icon, is there?
+
+                        // The link's display name must be set via property store.
+                        IPropertyStore* propStore;
+                        HRESULT hr = link->QueryInterface(&propStore);
+                        if (SUCCEEDED(hr)) {
+                                PROPVARIANT pv;
+                                pv.vt = VT_LPWSTR;    
+                                pv.pwszVal = description;
+
+                                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[] description;
+                }
+        }
+}
+
 #endif

backends/platform/sdl/win32/win32.h

@@ -31 +31 @@
 class OSystem_Win32 : public OSystem_SDL {
 public:
         virtual void init();
+        virtual void engineInit();
 
 protected:
         virtual Common::String getDefaultConfigFileName();