Changeset 30928 in vbox for trunk/src/VBox/Additions/WINNT/VBoxTray

Timestamp:

Jul 20, 2010 1:27:46 PM (15 years ago)

Author:

vboxsync

Message:

VBoxTray: Modularized tray icon handling, fixed icon leak.

File:

• trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxTray.cpp (modified) (18 diffs)

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxTray.cpp

@@ -4 +4 @@
 
 /*
- * Copyright (C) 2006-2009 Oracle Corporation
+ * Copyright (C) 2006-2010 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -40 +40 @@
 HINSTANCE             gInstance;
 HWND                  gToolWindow;
+NOTIFYICONDATA        gNotifyIconData;
+DWORD                 gMajorVersion;
 
 /* Prototypes */
@@ -85 +87 @@
 };
 
-static int vboxStartServices (VBOXSERVICEENV *pEnv, VBOXSERVICEINFO *pTable)
+static BOOL vboxTrayIconAdd()
+{
+    HICON hIcon = LoadIcon(gInstance, MAKEINTRESOURCE(IDI_VIRTUALBOX));
+    if (hIcon == NULL)
+    {
+        Log(("Could not load tray icon, err %08X\n", GetLastError()));
+        return FALSE;
+    }
+
+    /* Prepare the system tray icon. */
+    RT_ZERO(gNotifyIconData);
+    gNotifyIconData.cbSize           = NOTIFYICONDATA_V1_SIZE; // sizeof(NOTIFYICONDATA);
+    gNotifyIconData.hWnd             = gToolWindow;
+    gNotifyIconData.uID              = ID_TRAYICON;
+    gNotifyIconData.uFlags           = NIF_ICON | NIF_MESSAGE | NIF_TIP;
+    gNotifyIconData.uCallbackMessage = WM_VBOX_TRAY;
+    gNotifyIconData.hIcon            = hIcon;
+
+    sprintf(gNotifyIconData.szTip, "%s Guest Additions %d.%d.%dr%d",
+            VBOX_PRODUCT, VBOX_VERSION_MAJOR, VBOX_VERSION_MINOR, VBOX_VERSION_BUILD, VBOX_SVN_REV);
+
+    BOOL fCreated = Shell_NotifyIcon(NIM_ADD, &gNotifyIconData);
+    if (!fCreated)
+    {
+        Log(("Could not create tray icon, err %08X\n", GetLastError()));
+        RT_ZERO(gNotifyIconData);
+    }
+
+    if (hIcon)
+        DestroyIcon(hIcon);
+    return fCreated;
+}
+
+static void vboxTrayIconRemove()
+{
+    if (gNotifyIconData.cbSize > 0)
+    {
+        /* Remove the system tray icon and refresh system tray. */
+        Shell_NotifyIcon(NIM_DELETE, &gNotifyIconData);
+        HWND hTrayWnd = FindWindow("Shell_TrayWnd", NULL); /* We assume we only have one tray atm. */
+        if (hTrayWnd)
+        {
+            HWND hTrayNotifyWnd = FindWindowEx(hTrayWnd, 0, "TrayNotifyWnd", NULL);
+            if (hTrayNotifyWnd)
+                SendMessage(hTrayNotifyWnd, WM_PAINT, 0, NULL);
+        }
+        RT_ZERO(gNotifyIconData);
+    }
+}
+
+static int vboxStartServices(VBOXSERVICEENV *pEnv, VBOXSERVICEINFO *pTable)
 {
     Log(("VBoxTray: Starting services...\n"));
@@ -159 +211 @@
 }
 
-static void vboxStopServices (VBOXSERVICEENV *pEnv, VBOXSERVICEINFO *pTable)
+static void vboxStopServices(VBOXSERVICEENV *pEnv, VBOXSERVICEINFO *pTable)
 {
     if (!pEnv->hStopEvent)
@@ -236 +288 @@
     DWORD status = NO_ERROR;
 
-    /* open VBox guest driver */
+    /* Open VBox guest driver. */
     gVBoxDriver = CreateFile(VBOXGUEST_DEVICE_NAME,
                              GENERIC_READ | GENERIC_WRITE,
@@ -254 +306 @@
     if (status == NO_ERROR)
     {
-        /* create a custom window class */
+        /* Create a custom window class. */
         WNDCLASS windowClass = {0};
         windowClass.style         = CS_NOCLOSE;
@@ -269 +321 @@
     if (status == NO_ERROR)
     {
-        /* create our window */
+        /* Create our (invisible) tool window. */
         gToolWindow = CreateWindowEx(WS_EX_TOOLWINDOW | WS_EX_TRANSPARENT | WS_EX_TOPMOST,
                                      "VirtualBoxTool", "VirtualBoxTool",
@@ -282 +334 @@
     Log(("VBoxTray: Window Handle = %p, Status = %p\n", gToolWindow, status));
 
-    OSVERSIONINFO           info;
-    DWORD                   dwMajorVersion = 5; /* default XP */
+    OSVERSIONINFO info;
+    gMajorVersion = 5; /* default XP */
     info.dwOSVersionInfoSize = sizeof(info);
     if (GetVersionEx(&info))
     {
-        Log(("VBoxTray: Windows version major %d minor %d\n", info.dwMajorVersion, info.dwMinorVersion));
-        dwMajorVersion = info.dwMajorVersion;
+        Log(("VBoxTray: Windows version major %d minor %d.\n", info.dwMajorVersion, info.dwMinorVersion));
+        gMajorVersion = info.dwMajorVersion;
     }
 
@@ -314 +366 @@
 
         /* For Vista and up we need to change the integrity of the security descriptor too */
-        if (dwMajorVersion >= 6)
+        if (gMajorVersion >= 6)
         {
             HMODULE hModule;
@@ -349 +401 @@
         }
 
-        if (dwMajorVersion >= 5)        /* Only for W2K and up ... */
+        if (gMajorVersion >= 5)        /* Only for W2K and up ... */
         {
             ghSeamlessNotifyEvent = CreateEvent(&SecAttr, FALSE, FALSE, VBOXHOOK_GLOBAL_EVENT_NAME);
@@ -369 +421 @@
     status = VBoxDispIfInit(&svcEnv.dispIf);
 #ifdef VBOXWDDM
-    /* for now the display mode will be adjusted to WDDM mode if needed
-     * on display service initialization when it detects the display driver type */
+    /*
+     * For now the display mode will be adjusted to WDDM mode if needed
+     * on display service initialization when it detects the display driver type.
+     */
 #endif
 
     if (status == NO_ERROR)
     {
-        int rc = vboxStartServices (&svcEnv, vboxServiceTable);
+        int rc = vboxStartServices(&svcEnv, vboxServiceTable);
 
         if (RT_FAILURE (rc))
@@ -386 +440 @@
     if (status != NO_ERROR)
     {
-        vboxStopServices (&svcEnv, vboxServiceTable);
+        vboxStopServices(&svcEnv, vboxServiceTable);
         return;
     }
 
-    BOOL fTrayIconCreated = false;
-
-    /* prepare the system tray icon */
-    NOTIFYICONDATA ndata;
-    RT_ZERO (ndata);
-    ndata.cbSize           = NOTIFYICONDATA_V1_SIZE; // sizeof(NOTIFYICONDATA);
-    ndata.hWnd             = gToolWindow;
-    ndata.uID              = ID_TRAYICON;
-    ndata.uFlags           = NIF_ICON | NIF_MESSAGE | NIF_TIP;
-    ndata.uCallbackMessage = WM_VBOX_TRAY;
-    ndata.hIcon            = LoadIcon(gInstance, MAKEINTRESOURCE(IDI_VIRTUALBOX));
-    sprintf(ndata.szTip, "%s Guest Additions %d.%d.%dr%d", VBOX_PRODUCT, VBOX_VERSION_MAJOR, VBOX_VERSION_MINOR, VBOX_VERSION_BUILD, VBOX_SVN_REV);
-    Log(("VBoxTray: ndata.hWnd %08X, ndata.hIcon = %p\n", ndata.hWnd, ndata.hIcon));
+    if (   vboxTrayIconAdd()
+        && gMajorVersion >= 5) /* Only for W2K and up ... */
+    {
+        /* We're ready to create the tooltip balloon. */
+        /* Check in 10 seconds (@todo make seconds configurable) ... */
+        SetTimer(gToolWindow,
+                 WM_VBOX_CHECK_HOSTVERSION,
+                 10 * 1000, /* 10 seconds */
+                 NULL       /* No timerproc */);
+    }
 
     /* Boost thread priority to make sure we wake up early for seamless window notifications (not sure if it actually makes any difference though) */
@@ -419 +470 @@
 
     Log(("VBoxTray: Number of events to wait in main loop: %ld\n", dwEventCount));
-
-    while(true)
+    while (true)
     {
         DWORD waitResult = MsgWaitForMultipleObjectsEx(dwEventCount, hWaitEvent, 500, QS_ALLINPUT, 0);
         waitResult = waitResult - WAIT_OBJECT_0;
 
-        Log(("VBoxTray: Wait result  = %ld.\n", waitResult));
+        /* Only enable for message debugging, lots of traffic! */
+        //Log(("VBoxTray: Wait result  = %ld.\n", waitResult));
 
         if (waitResult == 0)
@@ -433 +484 @@
             break;
         }
-        else if ((waitResult == 1) && (ghSeamlessNotifyEvent!=0))       /* Only jump in, if seamless is active! */
+        else if (   (waitResult == 1)
+                 && (ghSeamlessNotifyEvent!=0)) /* Only jump in, if seamless is active! */
         {
             Log(("VBoxTray: Event 'Seamless' triggered.\n"));
@@ -456 +508 @@
                 DispatchMessage(&msg);
             }
-            /* we might have to repeat this operation because the shell might not be loaded yet */
-            if (!fTrayIconCreated)
-            {
-                fTrayIconCreated = Shell_NotifyIcon(NIM_ADD, &ndata);
-                Log(("VBoxTray: fTrayIconCreated = %d, err %08X\n", fTrayIconCreated, GetLastError ()));
-
-                /* We're ready to create the tooltip balloon. */
-                if (fTrayIconCreated && dwMajorVersion >= 5)
-                {
-                    /* Check in 10 seconds (@todo make seconds configurable) ... */
-                    SetTimer(gToolWindow,
-                             WM_VBOX_CHECK_HOSTVERSION,
-                             10000, /* 10 seconds */
-                             NULL   /* no timerproc */);
-                }
-            }
         }
     }
@@ -477 +513 @@
     Log(("VBoxTray: Returned from main loop, exiting ...\n"));
 
-    /* remove the system tray icon and refresh system tray */
-    Shell_NotifyIcon(NIM_DELETE, &ndata);
-    HWND hTrayWnd = FindWindow("Shell_TrayWnd", NULL); /* We assume we only have one tray atm */
-    HWND hTrayNotifyWnd = FindWindowEx(hTrayWnd, 0, "TrayNotifyWnd", NULL);
-    if (hTrayNotifyWnd)
-        SendMessage(hTrayNotifyWnd, WM_PAINT, 0, NULL);
-
-    Log(("VBoxTray: waiting for display change thread ...\n"));
-
-    vboxStopServices (&svcEnv, vboxServiceTable);
+    vboxTrayIconRemove();
+
+    Log(("VBoxTray: Waiting for display change thread ...\n"));
+
+    vboxStopServices(&svcEnv, vboxServiceTable);
 
     Log(("VBoxTray: Destroying tool window ...\n"));
 
-    /* destroy the tool window */
+    /* Destroy the tool window. */
     DestroyWindow(gToolWindow);
 
@@ -551 +582 @@
 LRESULT CALLBACK VBoxToolWndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
 {
+    static UINT s_uTaskbarCreated = 0;
+
     switch (msg)
     {
+        case WM_CREATE:
+            Log(("VBoxTray: Tool window created.\n"));
+            s_uTaskbarCreated = RegisterWindowMessage(TEXT("TaskbarCreated"));
+            if (!s_uTaskbarCreated)
+                Log(("VBoxTray: Cannot register message \"TaskbarCreated\"! Error = %ld\n", GetLastError()));
+            break;
+
         case WM_CLOSE:
             break;
 
         case WM_DESTROY:
+            Log(("VBoxTray: Tool window destroyed.\n"));
             KillTimer(gToolWindow, WM_VBOX_CHECK_HOSTVERSION);
             break;
@@ -609 +650 @@
 
         default:
-            return DefWindowProc(hwnd, msg, wParam, lParam);
-    }
-    return 0;
+
+            if(msg == s_uTaskbarCreated)
+            {
+                Log(("VBoxTray: Taskbar (re-)created, installing tray icon ...\n"));
+                vboxTrayIconAdd();
+            }
+            break;
+    }
+    return DefWindowProc(hwnd, msg, wParam, lParam);
 }