[SHELL32_APITEST] Extend ShellState API tests

- Skip registry tests if the key is missing, but keep testing
- Add tests for different bitmasks and compare amount of set bytes
- Add inter-process tests that verify shell behavior

All tests are confirmed to pass on Windows 2003, 7 and 10.

CORE-20585

Author: binarymaster

modules/rostests/apitests/shell32/ShellState.cpp

@@ -4,7 +4,9 @@
  * PURPOSE:         Test for SHELLSTATE
  * PROGRAMMERS:     Katayama Hirofumi MZ <katayama.hirofumi.mz@gmail.com>
  */
+
 #include "shelltest.h"
+#include "shell32_apitest_sub.h"
 
 #define NDEBUG
 #include <debug.h>
@@ -22,30 +24,37 @@ typedef struct REGSHELLSTATE
     SHELLSTATE ss;
 } REGSHELLSTATE, *PREGSHELLSTATE;
 
-static void dump(const char *name, const void *ptr, size_t siz)
+static const LPCWSTR s_pszExplorer =
+    L"Software\\Microsoft\\Windows\\CurrentVersion\\Explorer";
+static const LPCWSTR s_pszShellState =
+    L"ShellState";
+
+static ULONG dump(const char *name, const void *ptr, size_t siz)
 {
     char buf[256], sz[16];
+    ULONG ret = 0;
 
     StringCbCopyA(buf, sizeof(buf), name);
     StringCbCatA(buf, sizeof(buf), ": ");
 
     const BYTE *pb = reinterpret_cast<const BYTE *>(ptr);
     while (siz--)
     {
+        if (*pb)
+            ret++;
         StringCbPrintfA(sz, sizeof(sz), "%02X ", *pb++);
         StringCbCatA(buf, sizeof(buf), sz);
     }
 
     trace("%s\n", buf);
+    return ret;
 }
 
 static int read_key(REGSHELLSTATE *prss)
 {
     HKEY hKey;
     LONG result;
     DWORD cb;
-    static const LPCWSTR s_pszExplorer =
-        L"Software\\Microsoft\\Windows\\CurrentVersion\\Explorer";
 
     memset(prss, 0, sizeof(*prss));
 
@@ -60,7 +69,7 @@ static int read_key(REGSHELLSTATE *prss)
     }
 
     cb = sizeof(*prss);
-    result = RegQueryValueExW(hKey, L"ShellState", NULL, NULL, reinterpret_cast<LPBYTE>(prss), &cb);
+    result = RegQueryValueExW(hKey, s_pszShellState, NULL, NULL, reinterpret_cast<LPBYTE>(prss), &cb);
     RegCloseKey(hKey);
 
     ok(result == ERROR_SUCCESS, "result was %ld\n", result);
@@ -151,18 +160,204 @@ static int read_advanced_key(SHELLSTATE* pss)
 
 static int dump_pss(SHELLSTATE *pss)
 {
-    dump("SHELLSTATE", pss, sizeof(*pss));
+    dump("SHELLSTATE KEY", pss, sizeof(*pss));
     return 0;
 }
 
+static HWND start_sub(void)
+{
+    int retries = 50;
+    WCHAR s_szSubProgram[MAX_PATH]; // shell32_apitest_sub.exe
+    if (!FindSubProgram(s_szSubProgram, _countof(s_szSubProgram)))
+    {
+        skip("shell32_apitest_sub.exe not found\n");
+        return 0;
+    }
+
+    // Close the SUB_CLASSNAME windows
+    DoWaitForWindow(SUB_CLASSNAME, SUB_CLASSNAME, TRUE, TRUE);
+
+    // Execute sub program
+    HINSTANCE hinst = ShellExecuteW(NULL, NULL, s_szSubProgram, L"HIDE", NULL, SW_SHOWNORMAL);
+    if ((INT_PTR)hinst <= 32)
+    {
+        skip("Unable to run shell32_apitest_sub.exe.\n");
+        return 0;
+    }
+
+Retry:
+    HWND s_hSubWnd = DoWaitForWindow(SUB_CLASSNAME, SUB_CLASSNAME, FALSE, FALSE);
+    if (!s_hSubWnd)
+    {
+        if (--retries > 0)
+        {
+            Sleep(100);
+            goto Retry;
+        }
+        skip("Unable to find sub-program window.\n");
+        return 0;
+    }
+
+    return s_hSubWnd;
+}
+
+static void stop_sub(HWND s_hSubWnd)
+{
+    PostMessageW(s_hSubWnd, WM_COMMAND, IDNO, 0); // Finish
+    DoWaitForWindow(SUB_CLASSNAME, SUB_CLASSNAME, TRUE, TRUE); // Close sub-windows
+}
+
+static void process_test(SHELLSTATE *pss)
+{
+    SHELLSTATE bak, ss1, ss2;
+    SHELLSTATE_SUB sub;
+    HKEY hKey;
+    LONG result;
+
+    memset(&sub, 0, sizeof(sub));
+    COPYDATASTRUCT copyData = { ID_SHSTATE, sizeof(sub), &sub };
+
+    // Backup current state
+    memset(&bak, 0, sizeof(bak));
+    SHGetSetSettings(&bak, MAXDWORD, FALSE);
+
+    HWND s_hSubWnd = start_sub();
+    if (!s_hSubWnd)
+        return;
+
+    memset(&ss1, 0, sizeof(ss1));
+    SHGetSetSettings(&ss1, MAXDWORD, FALSE);
+
+    // Test 1: Read one field, then write another
+    sub.dwMask = SSF_DOUBLECLICKINWEBVIEW;
+    sub.bSet = FALSE;
+    SendMessageW(s_hSubWnd, WM_COPYDATA, 0, (LPARAM)&copyData);
+
+    sub.ss.fNoConfirmRecycle = !ss1.fNoConfirmRecycle;
+    ss1.fNoConfirmRecycle = sub.ss.fNoConfirmRecycle;
+    sub.dwMask = SSF_NOCONFIRMRECYCLE;
+    sub.bSet = TRUE;
+    SendMessageW(s_hSubWnd, WM_COPYDATA, 0, (LPARAM)&copyData);
+
+    memset(&ss2, 0, sizeof(ss2));
+    SHGetSetSettings(&ss2, MAXDWORD, FALSE);
+
+#define CHECK_BITS(x) ok(ss1.x == ss2.x, "ss2.%s expected %d, was %d\n", #x, (int)ss1.x, (int)ss2.x)
+    CHECK_BITS(fNoConfirmRecycle);
+    CHECK_BITS(fDoubleClickInWebView);
+    CHECK_BITS(fDesktopHTML);
+    CHECK_BITS(fWin95Classic);
+    CHECK_BITS(lParamSort);
+    CHECK_BITS(iSortDirection);
+    CHECK_BITS(fStartPanelOn);
+    CHECK_BITS(fShowCompColor);
+    CHECK_BITS(fShowAttribCol);
+    CHECK_BITS(fShowInfoTip);
+
+    stop_sub(s_hSubWnd);
+
+    // Test 2: Only write a field
+    s_hSubWnd = start_sub();
+    if (!s_hSubWnd)
+        goto Cleanup;
+
+    sub.ss.fNoConfirmRecycle = !ss1.fNoConfirmRecycle;
+    ss1.fNoConfirmRecycle = sub.ss.fNoConfirmRecycle;
+    sub.dwMask = SSF_NOCONFIRMRECYCLE;
+    sub.bSet = TRUE;
+    SendMessageW(s_hSubWnd, WM_COPYDATA, 0, (LPARAM)&copyData);
+
+    memset(&ss2, 0, sizeof(ss2));
+    SHGetSetSettings(&ss2, MAXDWORD, FALSE);
+
+    CHECK_BITS(fNoConfirmRecycle);
+    CHECK_BITS(fDoubleClickInWebView);
+    CHECK_BITS(fDesktopHTML);
+    CHECK_BITS(fWin95Classic);
+    CHECK_BITS(lParamSort);
+    CHECK_BITS(iSortDirection);
+    CHECK_BITS(fStartPanelOn);
+    CHECK_BITS(fShowCompColor);
+    CHECK_BITS(fShowAttribCol);
+    CHECK_BITS(fShowInfoTip);
+
+    stop_sub(s_hSubWnd);
+
+    // Test 3: Check default state values
+#define FLIP_FLAG(x) ss1.x = !ss1.x
+    FLIP_FLAG(fNoConfirmRecycle);
+    FLIP_FLAG(fDoubleClickInWebView);
+    FLIP_FLAG(fDesktopHTML);
+    FLIP_FLAG(fWin95Classic);
+    FLIP_FLAG(fStartPanelOn);
+    FLIP_FLAG(fShowCompColor);
+    FLIP_FLAG(fShowAttribCol);
+    FLIP_FLAG(fShowInfoTip);
+    SHGetSetSettings(&ss1, MAXDWORD, TRUE);
+
+    result = RegOpenKeyExW(HKEY_CURRENT_USER, s_pszExplorer, 0, KEY_SET_VALUE, &hKey);
+    if (result != ERROR_SUCCESS || !hKey)
+    {
+        skip("process_test(): RegOpenKeyEx failed: %ld\n", result);
+        goto Cleanup;
+    }
+
+    result = RegDeleteValueW(hKey, s_pszShellState);
+    RegCloseKey(hKey);
+
+    if (result != ERROR_SUCCESS)
+    {
+        skip("process_test(): RegDeleteValueW failed: %ld\n", result);
+        goto Cleanup;
+    }
+
+    s_hSubWnd = start_sub();
+    if (!s_hSubWnd)
+        goto Cleanup;
+
+    sub.dwMask = SSF_NOCONFIRMRECYCLE;
+    sub.bSet = FALSE;
+    SendMessageW(s_hSubWnd, WM_COPYDATA, 0, (LPARAM)&copyData);
+
+    sub.bSet = TRUE;
+    SendMessageW(s_hSubWnd, WM_COPYDATA, 0, (LPARAM)&copyData);
+
+    memset(&ss2, 0, sizeof(ss2));
+    SHGetSetSettings(&ss2, MAXDWORD, FALSE);
+
+#define CHECK_TRUE(x) ok(ss2.x, "ss2.%s expected to be TRUE\n", #x)
+#define CHECK_FALSE(x) ok(!ss2.x, "ss2.%s expected to be FALSE\n", #x)
+    if (GetNTVersion() < _WIN32_WINNT_WIN8)
+        CHECK_FALSE(fNoConfirmRecycle); // Different between Windows versions
+    else
+        CHECK_TRUE(fNoConfirmRecycle);
+    CHECK_TRUE(fDoubleClickInWebView);
+    CHECK_FALSE(fDesktopHTML);
+    CHECK_FALSE(fWin95Classic);
+    CHECK_TRUE(fStartPanelOn);
+    CHECK_BITS(fShowCompColor); // Keeps the state
+    CHECK_FALSE(fShowAttribCol);
+    CHECK_BITS(fShowInfoTip); // Keeps the state
+
+    stop_sub(s_hSubWnd);
+
+Cleanup:
+    // Restore current state
+    SHGetSetSettings(&bak, MAXDWORD, TRUE);
+
+    return;
+}
+
 START_TEST(ShellState)
 {
     OSVERSIONINFO osinfo;
     REGSHELLSTATE rss;
     SHELLSTATE ss, *pss;
     SHELLFLAGSTATE FlagState;
+    BOOL GotReg = TRUE;
     LPBYTE pb;
     int ret;
+    ULONG c1, c2;
 
     trace("GetVersion(): 0x%08lX\n", GetVersion());
 
@@ -200,7 +395,8 @@ START_TEST(ShellState)
     ret = read_key(&rss);
     if (ret)
     {
-        return;
+        GotReg = FALSE;
+        goto SkipReg;
     }
 
     dump_pss(pss);
@@ -242,6 +438,7 @@ START_TEST(ShellState)
     DUMP_BOOL(pss->fShowStatusBar);
 #endif
 
+SkipReg:
 #define SSF_MASK \
     (SSF_SHOWALLOBJECTS | SSF_SHOWEXTENSIONS | SSF_NOCONFIRMRECYCLE | SSF_SHOWSYSFILES | \
      SSF_SHOWCOMPCOLOR | SSF_DOUBLECLICKINWEBVIEW | SSF_DESKTOPHTML | \
@@ -253,6 +450,8 @@ START_TEST(ShellState)
     /* Get the settings */
     memset(&ss, 0, sizeof(ss));
     SHGetSetSettings(&ss, SSF_MASK, FALSE);
+    if (GotReg)
+    {
 #define CHECK_REG_FLAG(x) ok(pss->x == ss.x, "ss.%s expected %d, was %d\n", #x, (int)pss->x, (int)ss.x)
     CHECK_REG_FLAG(fShowAllObjects);
     CHECK_REG_FLAG(fShowExtensions);
@@ -275,6 +474,14 @@ START_TEST(ShellState)
 #if NTDDI_VERSION >= NTDDI_WIN8     // for future use
     CHECK_REG_FLAG(fShowStatusBar);
 #endif
+    }
+    c1 = dump("SHELLSTATE SSF_MASK", &ss, sizeof(ss));
+
+    memset(&ss, 0, sizeof(ss));
+    SHGetSetSettings(&ss, MAXDWORD, FALSE);
+    c2 = dump("SHELLSTATE MAXDWORD", &ss, sizeof(ss));
+
+    ok(c2 >= c1, "Set bytes in MAXDWORD state expected to be greater than %u, was %u\n", c1, c2);
 
     /* Get the flag settings */
     memset(&FlagState, 0, sizeof(FlagState));
@@ -297,6 +504,16 @@ START_TEST(ShellState)
     CHECK_FLAG(fAutoCheckSelect);
     CHECK_FLAG(fIconsOnly);
 #endif
+    c1 = dump("SHELLFLAGSTATE SSF_MASK", &FlagState, sizeof(FlagState));
+
+    memset(&FlagState, 0, sizeof(FlagState));
+    SHGetSettings(&FlagState, MAXDWORD);
+    c2 = dump("SHELLFLAGSTATE MAXDWORD", &FlagState, sizeof(FlagState));
+
+    ok(c2 >= c1, "Set bytes in MAXDWORD flags expected to be greater than %u, was %u\n", c1, c2);
+
+    /* Inter-process tests */
+    process_test(pss);
 
     /* Structure alignment tests */
 #if 1

modules/rostests/apitests/shell32/shell32_apitest_sub.cpp

@@ -5,7 +5,7 @@
  * COPYRIGHT:   Copyright 2020-2024 Katayama Hirofumi MZ (katayama.hirofumi.mz@gmail.com)
  */
 
-// This program is used in SHChangeNotify and ShellExecCmdLine testcases.
+// This program is used in SHChangeNotify, ShellExecCmdLine, and ShellState testcases.
 
 #include "shelltest.h"
 #include "shell32_apitest_sub.h"
@@ -308,6 +308,18 @@ static INT_PTR OnShellNotify(HWND hwnd, WPARAM wParam, LPARAM lParam)
     return TRUE;
 }
 
+static LRESULT OnCopyData(HWND hwnd, LPARAM lParam)
+{
+    COPYDATASTRUCT *cds = (COPYDATASTRUCT*)lParam;
+
+    if (hwnd != 0 || cds->dwData != ID_SHSTATE)
+        return 0;
+
+    PSHELLSTATE_SUB sub = (PSHELLSTATE_SUB)cds->lpData;
+    SHGetSetSettings(&sub->ss, sub->dwMask, sub->bSet);
+    return 1;
+}
+
 static LRESULT CALLBACK SubWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
 {
     switch (uMsg)
@@ -322,6 +334,9 @@ static LRESULT CALLBACK SubWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARA
         case WM_SHELL_NOTIFY:
             return OnShellNotify(hwnd, wParam, lParam);
 
+        case WM_COPYDATA:
+            return OnCopyData((HWND)wParam, lParam);
+
         case WM_DESTROY:
             OnDestroy(hwnd);
             break;
@@ -363,7 +378,7 @@ wWinMain(
         return -2;
     }
 
-    ShowWindow(hwnd, SW_SHOWNORMAL);
+    ShowWindow(hwnd, lstrcmpiW(lpCmdLine, L"HIDE") == 0 ? SW_HIDE : SW_SHOWNORMAL);
     UpdateWindow(hwnd);
 
     MSG msg;

modules/rostests/apitests/shell32/shell32_apitest_sub.h

@@ -12,6 +12,15 @@
 
 #define NUM_STAGE 10
 
+#define ID_SHSTATE 0xFEEDDEAF
+
+typedef struct SHELLSTATE_SUB
+{
+    SHELLSTATE ss;
+    DWORD dwMask;
+    BOOL bSet;
+} SHELLSTATE_SUB, *PSHELLSTATE_SUB;
+
 static inline BOOL FindSubProgram(LPWSTR pszSubProgram, DWORD cchSubProgram)
 {
     GetModuleFileNameW(NULL, pszSubProgram, cchSubProgram);