Cleanup in desktopbg.c, inspired by BeastL (slyhome|AT|ipnet|DOT|ua), bug #4985.

svn path=/trunk/; revision=44474

reactos/subsystems/win32/csrss/win32csr/desktopbg.c

@@ -8,6 +8,7 @@
  */
 
 #define NDEBUG
+
 #include "w32csr.h"
 #include <debug.h>
 
@@ -18,283 +19,302 @@
 
 typedef struct tagDTBG_THREAD_DATA
 {
-  HDESK Desktop;
+    HDESK Desktop;
-  HANDLE Event;
+    HANDLE Event;
-  NTSTATUS Status;
+    NTSTATUS Status;
 } DTBG_THREAD_DATA, *PDTBG_THREAD_DATA;
 
 typedef struct tagPRIVATE_NOTIFY_DESKTOP
 {
-  NMHDR hdr;
+    NMHDR hdr;
-  union
-  {
     struct /* PM_SHOW_DESKTOP */
     {
-      int Width;
+        int Width;
-      int Height;
+        int Height;
     } ShowDesktop;
-  };
 } PRIVATE_NOTIFY_DESKTOP, *PPRIVATE_NOTIFY_DESKTOP;
 
 static BOOL BgInitialized = FALSE;
 static HWND VisibleDesktopWindow = NULL;
 
-static LRESULT CALLBACK
+static
-DtbgWindowProc(HWND Wnd, UINT Msg, WPARAM wParam, LPARAM lParam)
+LRESULT
+CALLBACK
+DtbgWindowProc(HWND Wnd,
+               UINT Msg,
+               WPARAM wParam,
+               LPARAM lParam)
 {
-  PAINTSTRUCT PS;
+    PAINTSTRUCT PS;
-  HDC hDC;
 
-    switch(Msg)
+    switch (Msg)
     {
-      case WM_ERASEBKGND:
+        case WM_ERASEBKGND:
-        PaintDesktop((HDC)wParam);
+            PaintDesktop((HDC)wParam);
-        return 1;
+            return 1;
 
-      case WM_PAINT:
+        case WM_PAINT:
-      {
+            if (BeginPaint(Wnd, &PS))
-        if((hDC = BeginPaint(Wnd, &PS)))
+                EndPaint(Wnd, &PS);
-          EndPaint(Wnd, &PS);
-        return 0;
-      }
-
-      case WM_SETCURSOR:
-	return (LRESULT) SetCursor(LoadCursorW(0, (LPCWSTR)IDC_ARROW));
-
-      case WM_NCCREATE:
-        return (LRESULT) TRUE;
-
-      case WM_CREATE:
-        return 0;
-
-      case WM_CLOSE:
-        return 0;
-
-      case WM_NOTIFY:
-      {
-        PPRIVATE_NOTIFY_DESKTOP nmh = (PPRIVATE_NOTIFY_DESKTOP)lParam;
-
-        /* Use WM_NOTIFY for private messages since it can't be sent between
-           processes! */
-        switch(nmh->hdr.code)
-        {
-          case PM_SHOW_DESKTOP:
-          {
-            LRESULT Result;
-
-            Result = ! SetWindowPos(Wnd,
-                                    NULL, 0, 0,
-                                    nmh->ShowDesktop.Width,
-                                    nmh->ShowDesktop.Height,
-                                    SWP_NOACTIVATE | SWP_NOZORDER | SWP_SHOWWINDOW);
-            UpdateWindow(Wnd);
-            VisibleDesktopWindow = Wnd;
-            return Result;
-          }
-
-          case PM_HIDE_DESKTOP:
-          {
-            LRESULT Result;
-
-            Result = ! SetWindowPos(Wnd,
-                                    NULL, 0, 0, 0, 0,
-                                    SWP_NOACTIVATE | SWP_NOZORDER | SWP_NOMOVE | SWP_NOSIZE |
-                                    SWP_HIDEWINDOW);
-            UpdateWindow(Wnd);
-            VisibleDesktopWindow = NULL;
-            return Result;
-          }
-
-          default:
-            DPRINT("Unknown notification code 0x%x sent to the desktop window!\n", nmh->hdr.code);
             return 0;
+
+        case WM_SETCURSOR:
+            return (LRESULT)SetCursor(LoadCursorW(0, (LPCWSTR)IDC_ARROW));
+
+        case WM_NCCREATE:
+            return (LRESULT)TRUE;
+
+        case WM_CREATE:
+        case WM_CLOSE:
+            return 0;
+
+        case WM_NOTIFY:
+        {
+            PPRIVATE_NOTIFY_DESKTOP nmh = (PPRIVATE_NOTIFY_DESKTOP)lParam;
+
+            /* Use WM_NOTIFY for private messages since
+             * it can't be sent between processes!
+             */
+            switch (nmh->hdr.code)
+            {
+                case PM_SHOW_DESKTOP:
+                {
+                    LRESULT Result;
+
+                    Result = !SetWindowPos(Wnd, NULL, 0, 0,
+                                           nmh->ShowDesktop.Width,
+                                           nmh->ShowDesktop.Height,
+                                           SWP_NOACTIVATE | SWP_NOZORDER |
+                                           SWP_SHOWWINDOW);
+
+                    UpdateWindow(Wnd);
+                    VisibleDesktopWindow = Wnd;
+                    return Result;
+                }
+
+                case PM_HIDE_DESKTOP:
+                {
+                    LRESULT Result;
+
+                    Result = !SetWindowPos(Wnd, NULL, 0, 0, 0, 0,
+                                           SWP_NOACTIVATE | SWP_NOZORDER |
+                                           SWP_NOMOVE | SWP_NOSIZE | SWP_HIDEWINDOW);
+
+                    UpdateWindow(Wnd);
+                    VisibleDesktopWindow = NULL;
+                    return Result;
+                }
+
+                default:
+                    DPRINT("Unknown notification code 0x%x sent to the desktop window!\n",
+                           nmh->hdr.code);
+                    return 0;
+            }
         }
-      }
 
-      default:
+        default:
-        return DefWindowProcW(Wnd, Msg, wParam, lParam);
+            return DefWindowProcW(Wnd, Msg, wParam, lParam);
     }
 
-  return 0;
+    return 0;
 }
 
-static BOOL FASTCALL
+static
-DtbgInit()
+BOOL
+FASTCALL
+DtbgInit(VOID)
 {
-  WNDCLASSEXW Class;
+    WNDCLASSEXW Class;
-  ATOM ClassAtom;
+    ATOM ClassAtom;
 
-  /*
+    /*
-   * Create the desktop window class
+     * Create the desktop window class
-   */
+     */
-  Class.cbSize = sizeof(WNDCLASSEXW);
+    Class.cbSize = sizeof(WNDCLASSEXW);
-  Class.style = CS_GLOBALCLASS;
+    Class.style = CS_GLOBALCLASS;
-  Class.lpfnWndProc = DtbgWindowProc;
+    Class.lpfnWndProc = DtbgWindowProc;
-  Class.cbClsExtra = 0;
+    Class.cbClsExtra = 0;
-  Class.cbWndExtra = 0;
+    Class.cbWndExtra = 0;
-  Class.hInstance = (HINSTANCE) GetModuleHandleW(NULL);
+    Class.hInstance = (HINSTANCE)GetModuleHandleW(NULL);
-  Class.hIcon = NULL;
+    Class.hIcon = NULL;
-  Class.hCursor = NULL;
+    Class.hCursor = NULL;
-  Class.hbrBackground = GetSysColorBrush(COLOR_BACKGROUND);
+    Class.hbrBackground = GetSysColorBrush(COLOR_BACKGROUND);
-  Class.lpszMenuName = NULL;
+    Class.lpszMenuName = NULL;
-  Class.lpszClassName = (LPCWSTR) DESKTOP_WINDOW_ATOM;
+    Class.lpszClassName = (LPCWSTR)DESKTOP_WINDOW_ATOM;
-  ClassAtom = RegisterClassExW(&Class);
+    ClassAtom = RegisterClassExW(&Class);
-  if ((ATOM) 0 == ClassAtom)
+
+    if (ClassAtom == INVALID_ATOM)
     {
-      DPRINT1("Unable to register desktop background class (error %d)\n",
+        DPRINT1("Unable to register desktop background class (error %d)\n",
-              GetLastError());
+                GetLastError());
-      return FALSE;
-    }
-  VisibleDesktopWindow = NULL;
 
-  return TRUE;
+        return FALSE;
+    }
+
+    VisibleDesktopWindow = NULL;
+
+    return TRUE;
 }
 
-static DWORD WINAPI
+static
+DWORD
+WINAPI
 DtbgDesktopThread(PVOID Data)
 {
-  HWND BackgroundWnd;
+    HWND BackgroundWnd;
-  MSG msg;
+    MSG msg;
-  PDTBG_THREAD_DATA ThreadData = (PDTBG_THREAD_DATA) Data;
+    PDTBG_THREAD_DATA ThreadData = (PDTBG_THREAD_DATA)Data;
 
-  if (! SetThreadDesktop(ThreadData->Desktop))
+    if (!SetThreadDesktop(ThreadData->Desktop))
     {
-      DPRINT1("Failed to set thread desktop\n");
+        DPRINT1("Failed to set thread desktop\n");
-      ThreadData->Status = STATUS_UNSUCCESSFUL;
+        ThreadData->Status = STATUS_UNSUCCESSFUL;
-      SetEvent(ThreadData->Event);
+        SetEvent(ThreadData->Event);
-      return 1;
+        return 1;
-    }
-  BackgroundWnd = CreateWindowW((LPCWSTR) DESKTOP_WINDOW_ATOM,
-                                L"",
-                                WS_POPUP | WS_CLIPCHILDREN,
-                                0,
-                                0,
-                                0,
-                                0,
-                                NULL,
-                                NULL,
-                                (HINSTANCE) GetModuleHandleW(NULL),
-                                NULL);
-  if (NULL == BackgroundWnd)
-    {
-      DPRINT1("Failed to create desktop background window\n");
-      ThreadData->Status = STATUS_UNSUCCESSFUL;
-      SetEvent(ThreadData->Event);
-      return 1;
     }
 
-  ThreadData->Status = STATUS_SUCCESS;
+    BackgroundWnd = CreateWindowW((LPCWSTR)DESKTOP_WINDOW_ATOM,
-  SetEvent(ThreadData->Event);
+                                  L"",
+                                  WS_POPUP | WS_CLIPCHILDREN,
+                                  0, 0, 0, 0,
+                                  NULL, NULL,
+                                  (HINSTANCE)GetModuleHandleW(NULL),
+                                  NULL);
 
-  while (GetMessageW(&msg, NULL, 0, 0))
+    if (NULL == BackgroundWnd)
     {
-      TranslateMessage(&msg);
+        DPRINT1("Failed to create desktop background window\n");
-      DispatchMessageW(&msg);
+        ThreadData->Status = STATUS_UNSUCCESSFUL;
+        SetEvent(ThreadData->Event);
+        return 1;
     }
 
-  return 1;
+    ThreadData->Status = STATUS_SUCCESS;
+    SetEvent(ThreadData->Event);
+
+    while (GetMessageW(&msg, NULL, 0, 0))
+    {
+        TranslateMessage(&msg);
+        DispatchMessageW(&msg);
+    }
+
+    return 1;
 }
 
 CSR_API(CsrCreateDesktop)
 {
-  DTBG_THREAD_DATA ThreadData;
+    DTBG_THREAD_DATA ThreadData;
-  HANDLE ThreadHandle;
+    HANDLE ThreadHandle;
 
-  DPRINT("CsrCreateDesktop\n");
+    DPRINT("CsrCreateDesktop\n");
 
-  Request->Header.u1.s1.TotalLength = sizeof(CSR_API_MESSAGE);
+    Request->Header.u1.s1.TotalLength = sizeof(CSR_API_MESSAGE);
-  Request->Header.u1.s1.DataLength = sizeof(CSR_API_MESSAGE) - sizeof(PORT_MESSAGE);
+    Request->Header.u1.s1.DataLength = sizeof(CSR_API_MESSAGE) - sizeof(PORT_MESSAGE);
 
-  if (! BgInitialized)
+    if (!BgInitialized)
     {
-      BgInitialized = TRUE;
+        BgInitialized = TRUE;
-      if (! DtbgInit())
+
-        {
+        if (!DtbgInit())
-          return STATUS_UNSUCCESSFUL;
+            return STATUS_UNSUCCESSFUL;
-        }
     }
 
-  /*
+    /*
-   * the desktop handle we got from win32k is in the scope of CSRSS so we can just use it
+     * The desktop handle we got from win32k is in
-   */
+     * the scope of CSRSS so we can just use it.
-  ThreadData.Desktop = Request->Data.CreateDesktopRequest.DesktopHandle;
+     */
+    ThreadData.Desktop = Request->Data.CreateDesktopRequest.DesktopHandle;
 
-  ThreadData.Event = CreateEventW(NULL, FALSE, FALSE, NULL);
+    ThreadData.Event = CreateEventW(NULL, FALSE, FALSE, NULL);
-  if (NULL == ThreadData.Event)
+
+    if (NULL == ThreadData.Event)
     {
-      DPRINT1("Failed to create event (error %d)\n", GetLastError());
+        DPRINT1("Failed to create event (error %d)\n", GetLastError());
-      return STATUS_UNSUCCESSFUL;
+        return STATUS_UNSUCCESSFUL;
     }
-  ThreadHandle = CreateThread(NULL,
+
-                              0,
+    ThreadHandle = CreateThread(NULL,
-                              DtbgDesktopThread,
+                                0,
-                              (PVOID) &ThreadData,
+                                DtbgDesktopThread,
-                              0,
+                                (PVOID)&ThreadData,
-                              NULL);
+                                0,
-  if (NULL == ThreadHandle)
+                                NULL);
+
+    if (NULL == ThreadHandle)
     {
-      CloseHandle(ThreadData.Event);
+        CloseHandle(ThreadData.Event);
-      DPRINT1("Failed to create desktop window thread.\n");
+        DPRINT1("Failed to create desktop window thread.\n");
-      return STATUS_UNSUCCESSFUL;
+        return STATUS_UNSUCCESSFUL;
     }
-  CloseHandle(ThreadHandle);
 
-  WaitForSingleObject(ThreadData.Event, INFINITE);
+    CloseHandle(ThreadHandle);
-  CloseHandle(ThreadData.Event);
 
-  return ThreadData.Status;
+    WaitForSingleObject(ThreadData.Event, INFINITE);
+    CloseHandle(ThreadData.Event);
+
+    return ThreadData.Status;
 }
 
 CSR_API(CsrShowDesktop)
 {
-  PRIVATE_NOTIFY_DESKTOP nmh;
+    PRIVATE_NOTIFY_DESKTOP nmh;
-  DPRINT("CsrShowDesktop\n");
+    DPRINT("CsrShowDesktop\n");
 
-  Request->Header.u1.s1.TotalLength = sizeof(CSR_API_MESSAGE);
+    Request->Header.u1.s1.TotalLength = sizeof(CSR_API_MESSAGE);
-  Request->Header.u1.s1.DataLength = sizeof(CSR_API_MESSAGE) - sizeof(PORT_MESSAGE);
+    Request->Header.u1.s1.DataLength = sizeof(CSR_API_MESSAGE) - sizeof(PORT_MESSAGE);
 
-  nmh.hdr.hwndFrom = Request->Data.ShowDesktopRequest.DesktopWindow;
+    nmh.hdr.hwndFrom = Request->Data.ShowDesktopRequest.DesktopWindow;
-  nmh.hdr.idFrom = 0;
+    nmh.hdr.idFrom = 0;
-  nmh.hdr.code = PM_SHOW_DESKTOP;
+    nmh.hdr.code = PM_SHOW_DESKTOP;
 
-  nmh.ShowDesktop.Width = (int)Request->Data.ShowDesktopRequest.Width;
+    nmh.ShowDesktop.Width = (int)Request->Data.ShowDesktopRequest.Width;
-  nmh.ShowDesktop.Height = (int)Request->Data.ShowDesktopRequest.Height;
+    nmh.ShowDesktop.Height = (int)Request->Data.ShowDesktopRequest.Height;
 
-  return SendMessageW(Request->Data.ShowDesktopRequest.DesktopWindow,
+    if (SendMessageW(Request->Data.ShowDesktopRequest.DesktopWindow,
-                      WM_NOTIFY,
+                     WM_NOTIFY,
-                      (WPARAM)nmh.hdr.hwndFrom,
+                     (WPARAM)nmh.hdr.hwndFrom,
-                      (LPARAM)&nmh)
+                     (LPARAM)&nmh))
-         ? STATUS_UNSUCCESSFUL : STATUS_SUCCESS;
+    {
+        return STATUS_UNSUCCESSFUL;
+    }
+
+    return STATUS_SUCCESS;
 }
 
 CSR_API(CsrHideDesktop)
 {
-  PRIVATE_NOTIFY_DESKTOP nmh;
+    PRIVATE_NOTIFY_DESKTOP nmh;
-  DPRINT("CsrHideDesktop\n");
+    DPRINT("CsrHideDesktop\n");
 
-  Request->Header.u1.s1.TotalLength = sizeof(CSR_API_MESSAGE);
+    Request->Header.u1.s1.TotalLength = sizeof(CSR_API_MESSAGE);
-  Request->Header.u1.s1.DataLength = sizeof(CSR_API_MESSAGE) - sizeof(PORT_MESSAGE);
+    Request->Header.u1.s1.DataLength = sizeof(CSR_API_MESSAGE) - sizeof(PORT_MESSAGE);
 
-  nmh.hdr.hwndFrom = Request->Data.ShowDesktopRequest.DesktopWindow;
+    nmh.hdr.hwndFrom = Request->Data.ShowDesktopRequest.DesktopWindow;
-  nmh.hdr.idFrom = 0;
+    nmh.hdr.idFrom = 0;
-  nmh.hdr.code = PM_HIDE_DESKTOP;
+    nmh.hdr.code = PM_HIDE_DESKTOP;
 
-  return SendMessageW(Request->Data.ShowDesktopRequest.DesktopWindow,
+    if (SendMessageW(Request->Data.ShowDesktopRequest.DesktopWindow,
-                      WM_NOTIFY,
+                     WM_NOTIFY,
-                      (WPARAM)nmh.hdr.hwndFrom,
+                     (WPARAM)nmh.hdr.hwndFrom,
-                      (LPARAM)&nmh)
+                     (LPARAM)&nmh))
-         ? STATUS_UNSUCCESSFUL : STATUS_SUCCESS;
-}
-
-BOOL FASTCALL
-DtbgIsDesktopVisible(VOID)
-{
-  if (NULL != VisibleDesktopWindow && ! IsWindowVisible(VisibleDesktopWindow))
     {
-      VisibleDesktopWindow = NULL;
+        return STATUS_UNSUCCESSFUL;
     }
 
-  return NULL != VisibleDesktopWindow;
+    return STATUS_SUCCESS;
+}
+
+BOOL
+FASTCALL
+DtbgIsDesktopVisible(VOID)
+{
+    if (VisibleDesktopWindow != NULL &&
+        !IsWindowVisible(VisibleDesktopWindow))
+    {
+        VisibleDesktopWindow = NULL;
+    }
+
+    return VisibleDesktopWindow != NULL;
 }
 
 /* EOF */