[USER32] Implement IsServerSideWindow (undocumented) #7577

oleg-dubinskiy · 2024-12-23T22:33:59Z

Purpose

Implement IsServerSideWindow function in user32. It checks whether a window has a window procedure that resides in kernel mode and returns a boolean condition based on the appropriate internal window state flag (WNDS_SERVERSIDEWINDOWPROC).
This function is not officially documented by Microsoft, but fortunately it has unofficial documentation at http://undoc.airesoft.co.uk/user32.dll/IsServerSideWindow.php. According to that doc, bServerSideWindowProc bit seems actually correspond to WNDS_SERVERSIDEWINDOWPROC.
Required and used internally by uxtheme.dll from Windows XP/2003/Vista/7/etc. The log spams with it a lot, when using uxtheme.dll from Windows in ReactOS.

JIRA issue: CORE-19946

Proposed changes

Implement the function itself.
Add its prototype in the header (since the function is not officially documented).
Write an apitest for this function.

TODO

Fix/add correct test condition in apitest, to properly test the behaviour of the function! Currently, the function returns FALSE in both cases, and both in Windows and ReactOS, which means the condition for input window is not tested properly.
Also, an apitest probably needs to be improved in other parts.

Analysis

As it's visible on the following screenshot, uxtheme.dll actually needs that function in Windows XP SP3 at least:

Since the function is not offfically documented. Required by the further implementation and an appropriate apitest. CORE-19946

oleg-dubinskiy · 2024-12-23T22:38:25Z

Note: with current state of this PR, results of executing an apitest are identical both in ReactOS and Windows.

modules/rostests/win32/user32/serverside/serverside.c

…ted) Add a test for IsServerSideWindow() function is user32. It tests whether the window procedure of the window resides in the kernel mode or not. It is not documented by Microsoft, but fortunately has unofficial (3rd party) documentation at http://undoc.airesoft.co.uk/user32.dll/IsServerSideWindow.php. Required and used internally by uxtheme.dll from XP/2003/Vista/7/etc. TODO: Fix/add correct test condition, to properly test the behavoiur of the function! Currently, the function returns FALSE in both cases, which means the condition for input window is not tested properly.

Implement IsServerSideWindow function in user32. It checks whether a window has a window procedure that resides in kernel mode and returns a boolean condition based on the appropriate internal window state flag (WNDS_SERVERSIDEWINDOWPROC). This function is not officially documented by Microsoft, but fortunately it has unofficial documentation at http://undoc.airesoft.co.uk/user32.dll/IsServerSideWindow.php. Required and used internally by uxtheme.dll from Windows XP/2003/Vista/7/etc. The log spams with it a lot, when using uxtheme.dll from Windows in ReactOS. CORE-19946

HBelusca

Please consider converting the serverside test into a true apitest (to be added in user32_apitest, see modules/rostests/apitests/user32/).

HBelusca · 2024-12-24T10:17:33Z

modules/rostests/win32/user32/serverside/serverside.c

+
+/* This testapp tests behaviour of IsServerSideWindow() function in user32. */
+
+#define _WINE


This is not a wine test, so please remove this.

Yeah, it's not. But this define is required to properly include undocuser.h (which contains IsServerSideWindow declaration) from winuser.h. See https://git.reactos.org/?p=reactos.git;a=blob;f=sdk/include/psdk/winuser.h;hb=d7f1a784a86570863804daaf6479ffba2863422f#l5891. But I think it can be included directly in apitest instead.

No, this is a hack for Wine code only.
For ReactOS code, you explicitly include the undocuser.h header when you need it, see for example:
https://git.reactos.org/?p=reactos.git&a=search&h=HEAD&st=grep&s=undocuser.h

HBelusca · 2024-12-24T10:18:17Z

modules/rostests/win32/user32/serverside/serverside.c

+                      LPWSTR lpCmdLine,
+                      int nCmdShow)
+{
+    HWND hWnd1a, hWnd1b;


You can just use one single window handle hWnd, and you use this one consecutively for each CreateWindowExW + the test.

HBelusca · 2024-12-24T10:18:29Z

modules/rostests/win32/user32/serverside/serverside.c

+    UINT result;
+    BOOL ret;
+
+    memset(&wcx, 0, sizeof(wcx));


Suggested change

memset(&wcx, 0, sizeof(wcx));

ZeroMemory(&wcx, sizeof(wcx));

HBelusca · 2024-12-24T10:19:13Z

modules/rostests/win32/user32/serverside/serverside.c

+        DPRINT("OK: the window %p has a valid kernel mode wndproc\n", hWnd1a);
+    else
+        DPRINT("FAIL: the window %p is not valid or has no valid kernel mode wndproc\n", hWnd1a);
+


Missing: DestroyWindow(hWnd1a);

HBelusca · 2024-12-24T10:19:22Z

modules/rostests/win32/user32/serverside/serverside.c

+        DPRINT("FAIL: the window %p has a valid kernel mode wndproc when it shouldn't\n", hWnd1b);
+    else
+        DPRINT("OK: the window %p has no valid kernel mode wndproc\n", hWnd1b);
+


Missing: DestroyWindow(hWnd1b);

HBelusca · 2024-12-24T10:20:57Z

win32ss/user/user32/windows/window.c

+    if (Wnd != NULL)
+        return (Wnd->state & WNDS_SERVERSIDEWINDOWPROC) != 0;
+
+    return FALSE;


Suggested change

if (Wnd != NULL)

return (Wnd->state & WNDS_SERVERSIDEWINDOWPROC) != 0;

return FALSE;

if (!Wnd)

return FALSE;

return (Wnd->state & WNDS_SERVERSIDEWINDOWPROC) != 0;

or a one-line:

return (Wnd ? !!(Wnd->state & WNDS_SERVERSIDEWINDOWPROC) : FALSE);

HBelusca · 2024-12-24T10:23:46Z

win32ss/user/user32/windows/window.c

+IsServerSideWindow(
+    _In_ HWND hWnd)
+{
+    PWND Wnd = ValidateHwnd(hWnd);


Note that this function (and thus, your IsServerSideWindow implementation as it is currently written) will set the last-error in case the window handle is invalid. You should probably add a test for this.
If the last-error remains untouched, then please use ValidateHwndNoErr instead.

HBelusca · 2024-12-24T10:24:29Z

modules/rostests/win32/user32/serverside/serverside.c

+    WNDCLASSEXW wcx;
+    UINT result;
+    BOOL ret;
+


Missing: testing IsServerSideWindow with invalid window handles (e.g. NULL and 0xdeadbeef), and check the last-error.

HBelusca · 2024-12-24T10:24:50Z

modules/rostests/win32/user32/serverside/serverside.c

+    ShowWindow(hWnd1a, SW_SHOW);
+    UpdateWindow(hWnd1a);
+
+    ret = IsServerSideWindow(hWnd1a);


It would be of interest to check whether the last-error has been set to something, or is left unchanged.

wjk

Not much to say. The background brush issue is the only thing that jumped out at me, and @HBelusca’s review is far more thorough than mine could ever be.

[SDK] Add a prototype for IsServerSideWindow function in undocuser.h

bf309a0

Since the function is not offfically documented. Required by the further implementation and an appropriate apitest. CORE-19946

oleg-dubinskiy added the enhancement For PRs with an enhancement/new feature. label Dec 23, 2024

oleg-dubinskiy requested review from tkreuzer, binarymaster, learn-more, HBelusca, DarkFire01, Doug-Lyons, JoachimHenze, GeoB99, TAN-Gaming and whindsaks December 23, 2024 22:33

oleg-dubinskiy self-assigned this Dec 23, 2024

github-actions bot added ROSTESTS Label for ROS testcases PRs. Win32SS For Win32 subsystem (Win32k, GDI/USER DLLs, etc.) related components PRs. labels Dec 23, 2024

wjk reviewed Dec 23, 2024

View reviewed changes

modules/rostests/win32/user32/serverside/serverside.c Outdated Show resolved Hide resolved

oleg-dubinskiy added 2 commits December 24, 2024 09:59

oleg-dubinskiy force-pushed the IsServerSideWindow branch from 37d1194 to 7909f7d Compare December 24, 2024 09:00

oleg-dubinskiy requested a review from wjk December 24, 2024 09:18

HBelusca reviewed Dec 24, 2024

View reviewed changes

wjk approved these changes Dec 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[USER32] Implement IsServerSideWindow (undocumented) #7577

[USER32] Implement IsServerSideWindow (undocumented) #7577

oleg-dubinskiy commented Dec 23, 2024

oleg-dubinskiy commented Dec 23, 2024

HBelusca left a comment •

edited

Loading

HBelusca Dec 24, 2024

oleg-dubinskiy Dec 24, 2024 •

edited

Loading

HBelusca Dec 24, 2024

HBelusca Dec 24, 2024

HBelusca Dec 24, 2024

HBelusca Dec 24, 2024

HBelusca Dec 24, 2024

HBelusca Dec 24, 2024

HBelusca Dec 24, 2024

HBelusca Dec 24, 2024

HBelusca Dec 24, 2024

wjk left a comment


		/* This testapp tests behaviour of IsServerSideWindow() function in user32. */

		#define _WINE

[USER32] Implement IsServerSideWindow (undocumented) #7577

Are you sure you want to change the base?

[USER32] Implement IsServerSideWindow (undocumented) #7577

Conversation

oleg-dubinskiy commented Dec 23, 2024

Purpose

Proposed changes

TODO

Analysis

oleg-dubinskiy commented Dec 23, 2024

HBelusca left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oleg-dubinskiy Dec 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wjk left a comment

Choose a reason for hiding this comment

HBelusca left a comment •

edited

Loading

oleg-dubinskiy Dec 24, 2024 •

edited

Loading