Better TrayIcon error handling

Author: benbuck

src/Finestray.cpp

@@ -193,9 +193,12 @@ int WINAPI wWinMain(_In_ HINSTANCE hinstance, _In_opt_ HINSTANCE prevHinstance,
     // ShowWindow(appWindow_, nCmdShow);
     (void)nCmdShow;
 
+    ErrorContext err;
+
     // create a tray icon for the app
-    if (!trayIcon_.create(appWindow_, appWindow_, WM_TRAYWINDOW, hicon)) {
-        errorMessage(IDS_ERROR_CREATE_TRAY_ICON);
+    err = trayIcon_.create(appWindow_, appWindow_, WM_TRAYWINDOW, hicon);
+    if (err) {
+        errorMessage(err);
         return IDS_ERROR_CREATE_TRAY_ICON;
     }
 
@@ -218,7 +221,7 @@ int WINAPI wWinMain(_In_ HINSTANCE hinstance, _In_opt_ HINSTANCE prevHinstance,
         return IDS_ERROR_REGISTER_EVENTHOOK;
     }
 
-    ErrorContext err = start();
+    err = start();
     if (err) {
         errorMessage(err);
         settingsDialogWindow_ = SettingsDialog::create(appWindow_, settings_, onSettingsDialogComplete);

src/MinimizedWindow.cpp

@@ -15,6 +15,7 @@
 #include "MinimizedWindow.h"
 
 // App
+#include "Helpers.h"
 #include "Log.h"
 #include "StringUtility.h"
 #include "TrayIcon.h"
@@ -47,7 +48,6 @@ typedef std::vector<MinimizedWindowData> MinimizedWindows;
 MinimizedWindows minimizedWindows_;
 
 MinimizedWindows::iterator findMinimizedWindow(HWND hwnd);
-TrayIcon * createTrayIcon(HWND hwnd, HWND messageHwnd);
 
 } // anonymous namespace
 
@@ -70,7 +70,13 @@ void minimize(HWND hwnd, HWND messageHwnd, MinimizePlacement minimizePlacement)
 
     std::unique_ptr<TrayIcon> trayIcon;
     if (minimizePlacementIncludesTray(minimizePlacement)) {
-        trayIcon.reset(createTrayIcon(hwnd, messageHwnd));
+        trayIcon.reset(new TrayIcon());
+        ErrorContext err = trayIcon->create(hwnd, messageHwnd, WM_TRAYWINDOW, WindowIcon::get(hwnd));
+        if (err) {
+            WARNING_PRINTF("failed to create tray icon for minimized window %#x\n", hwnd);
+            trayIcon.reset();
+            errorMessage(err);
+        }
     }
 
     minimizedWindows_.emplace_back(hwnd, messageHwnd, std::move(trayIcon));
@@ -112,7 +118,17 @@ void addAll(MinimizePlacement minimizePlacement)
         MinimizedWindowData & minimizedWindow = *it;
         if (minimizePlacementIncludesTray(minimizePlacement)) {
             if (!minimizedWindow.trayIcon_) {
-                minimizedWindow.trayIcon_.reset(createTrayIcon(minimizedWindow.hwnd_, minimizedWindow.messageHwnd_));
+                minimizedWindow.trayIcon_.reset(new TrayIcon());
+                ErrorContext err = minimizedWindow.trayIcon_->create(
+                    minimizedWindow.hwnd_,
+                    minimizedWindow.messageHwnd_,
+                    WM_TRAYWINDOW,
+                    WindowIcon::get(minimizedWindow.hwnd_));
+                if (err) {
+                    WARNING_PRINTF("failed to create tray icon for minimized window %#x\n", minimizedWindow.hwnd_);
+                    minimizedWindow.trayIcon_.reset();
+                    errorMessage(err);
+                }
             }
         } else {
             if (minimizedWindow.trayIcon_) {
@@ -204,18 +220,4 @@ MinimizedWindows::iterator findMinimizedWindow(HWND hwnd)
         });
 }
 
-TrayIcon * createTrayIcon(HWND hwnd, HWND messageHwnd)
-{
-    TrayIcon * trayIcon = new TrayIcon();
-
-    HICON hicon = WindowIcon::get(hwnd);
-    if (!hicon) {
-        hicon = LoadIcon(nullptr, IDI_APPLICATION);
-    }
-
-    trayIcon->create(hwnd, messageHwnd, WM_TRAYWINDOW, hicon);
-
-    return trayIcon;
-}
-
 } // anonymous namespace

src/TrayIcon.cpp

@@ -16,6 +16,7 @@
 
 // App
 #include "Log.h"
+#include "Resource.h"
 #include "StringUtility.h"
 
 volatile LONG TrayIcon::gid_ = 0;
@@ -25,11 +26,11 @@ TrayIcon::~TrayIcon()
     destroy();
 }
 
-bool TrayIcon::create(HWND hwnd, HWND messageHwnd, UINT msg, HICON hicon)
+ErrorContext TrayIcon::create(HWND hwnd, HWND messageHwnd, UINT msg, HICON hicon)
 {
     if (nid_.uID) {
         WARNING_PRINTF("attempt to re-create tray icon %u\n", nid_.uID);
-        return false;
+        return ErrorContext(IDS_ERROR_CREATE_TRAY_ICON, "tray icon already exists");
     }
 
     LONG id = InterlockedIncrement(&gid_);
@@ -40,7 +41,7 @@ bool TrayIcon::create(HWND hwnd, HWND messageHwnd, UINT msg, HICON hicon)
     nid_.uID = (UINT)id;
     nid_.uFlags = NIF_MESSAGE | NIF_ICON | NIF_TIP;
     nid_.uCallbackMessage = msg;
-    nid_.hIcon = hicon;
+    nid_.hIcon = hicon ? hicon : LoadIcon(nullptr, IDI_APPLICATION);
     nid_.uVersion = NOTIFYICON_VERSION;
 
     if (!GetWindowTextA(hwnd, nid_.szTip, sizeof(nid_.szTip) / sizeof(nid_.szTip[0])) &&
@@ -49,22 +50,20 @@ bool TrayIcon::create(HWND hwnd, HWND messageHwnd, UINT msg, HICON hicon)
     }
 
     if (!Shell_NotifyIconA(NIM_ADD, &nid_)) {
-        WARNING_PRINTF(
-            "could not add tray icon, Shell_NotifyIcon() failed: %s\n",
-            StringUtility::lastErrorString().c_str());
+        std::string lastErrorString = StringUtility::lastErrorString();
+        WARNING_PRINTF("could not add tray icon, Shell_NotifyIcon() failed: %s\n", lastErrorString.c_str());
         ZeroMemory(&nid_, sizeof(nid_));
-        return false;
+        return ErrorContext(IDS_ERROR_CREATE_TRAY_ICON, lastErrorString + "(NIM_ADD)");
     }
 
     if (!Shell_NotifyIconA(NIM_SETVERSION, &nid_)) {
-        WARNING_PRINTF(
-            "could not set tray icon version, Shell_NotifyIcon() failed: %s\n",
-            StringUtility::lastErrorString().c_str());
+        std::string lastErrorString = StringUtility::lastErrorString();
+        WARNING_PRINTF("could not set tray icon version, Shell_NotifyIcon() failed: %s\n", lastErrorString.c_str());
         destroy();
-        return false;
+        return ErrorContext(IDS_ERROR_CREATE_TRAY_ICON, lastErrorString + "(NIM_SETVERSION)");
     }
 
-    return true;
+    return ErrorContext();
 }
 
 void TrayIcon::destroy()

src/TrayIcon.h

@@ -14,6 +14,9 @@
 
 #pragma once
 
+// App
+#include "ErrorContext.h"
+
 // Windows
 #include <Windows.h>
 #include <shellapi.h>
@@ -28,7 +31,7 @@ class TrayIcon
     TrayIcon() = default;
     ~TrayIcon();
 
-    bool create(HWND hwnd, HWND messageHwnd, UINT msg, HICON hicon);
+    ErrorContext create(HWND hwnd, HWND messageHwnd, UINT msg, HICON hicon);
     void destroy();
 
     void updateTip(const std::string & tip);