Ticket #9: taskbar.2008.06.16.patch

clientgui/BOINCTaskBar.cpp

@@ -144 +144 @@
 
     // Which icon should be displayed?
     if (!pDoc->IsConnected()) {
-        SetIcon(m_iconTaskBarDisconnected, wxEmptyString);
+        SetIcon(m_iconTaskBarDisconnected);
     } else {
         if (RUN_MODE_NEVER == status.task_mode) {
-            SetIcon(m_iconTaskBarSnooze, wxEmptyString);
+            SetIcon(m_iconTaskBarSnooze);
         } else {
-            SetIcon(m_iconTaskBarNormal, wxEmptyString);
+            SetIcon(m_iconTaskBarNormal);
         }
     }
 
@@ -289 +289 @@
     wxLogTrace(wxT("Function Start/End"), wxT("CTaskBarIcon::OnShutdown - Function End"));
 }
 
-
+// Note: tooltip must not have a trailing linebreak.
 void CTaskBarIcon::OnMouseMove(wxTaskBarIconEvent& WXUNUSED(event)) {
 
     wxTimeSpan tsLastHover(wxDateTime::Now() - m_dtLastHoverDetected);
@@ -297 +297 @@
         m_dtLastHoverDetected = wxDateTime::Now();
 
         CMainDocument* pDoc                 = wxGetApp().GetDocument();
+        CSkinAdvanced* pSkinAdvanced        = wxGetApp().GetSkinManager()->GetAdvanced();
+        wxString       strTitle             = wxEmptyString;
         wxString       strMachineName       = wxEmptyString;
         wxString       strMessage           = wxEmptyString;
         wxString       strBuffer            = wxEmptyString;
         wxString       strProjectName       = wxEmptyString;
         float          fProgress            = 0;
-        bool           bIsActive            = false;
-        bool           bIsExecuting         = false;
-        bool           bIsDownloaded        = false;
-        wxInt32        iResultCount         = 0;
-        wxInt32        iIndex               = 0;
-        wxIcon         iconIcon             = wxNullIcon;
         CC_STATUS      status;
 
         wxASSERT(pDoc);
+        wxASSERT(pSkinAdvanced);
         wxASSERT(wxDynamicCast(pDoc, CMainDocument));
+        wxASSERT(wxDynamicCast(pSkinAdvanced, CSkinAdvanced));
 
+        // Construct tooltip title.
+        strTitle = pSkinAdvanced->GetApplicationName();
+
         if (pDoc->IsConnected()) {
-            iconIcon = m_iconTaskBarNormal;
+            pDoc->GetConnectedComputerName(strMachineName);
 
+            // Only show machine name if connected to remote machine.
+            if (!pDoc->IsComputerNameLocal(strMachineName)) {
+                strTitle = strTitle + wxT(" - (") + strMachineName + wxT(")");
+            }
+
+                        strMessage += strTitle;
+
             pDoc->GetCoreClientStatus(status);
             if (status.task_suspend_reason && !(status.task_suspend_reason & SUSPEND_REASON_CPU_USAGE_LIMIT)) {
                 strBuffer.Printf(
-                    _("Computation is suspended.\n")
+                    _("\nComputation is suspended.")
                 );
                 strMessage += strBuffer;
             }
 
             if (status.network_suspend_reason && !(status.network_suspend_reason & SUSPEND_REASON_CPU_USAGE_LIMIT)) {
                 strBuffer.Printf(
-                    _("Network activity is suspended.\n")
+                    _("\nNetwork activity is suspended.")
                 );
                 strMessage += strBuffer;
             }
 
-            if (strMessage.Length() > 0) {
-                strMessage += wxT("\n");
-            }
+            std::vector<RESULT*> tasks = GetRunningTasks(pDoc);
 
-            iResultCount = pDoc->GetWorkCount();
-            for (iIndex = 0; iIndex < iResultCount; iIndex++) {
-                RESULT* result = pDoc->result(iIndex);
-                RESULT* state_result = NULL;
-                std::string project_name;
+            if (tasks.size() == 0) {
+                strMessage += _("\nNo running tasks.");
+            } else if (tasks.size() < 3) {
 
-                bIsDownloaded = (result->state == RESULT_FILES_DOWNLOADED);
-                bIsActive     = result->active_task;
-                bIsExecuting  = (result->scheduler_state == CPU_SCHED_SCHEDULED);
-                if (!(bIsActive) || !(bIsDownloaded) || !(bIsExecuting)) continue;
+                // Limit list of running tasks to 2, to avoid overflow.
+                std::vector<RESULT*>::iterator i = tasks.begin();
+                while (i != tasks.end()) {
+                    RESULT* task = *i;
+                    std::string project_name;
 
-                if (result) {
-                    state_result = pDoc->state.lookup_result(result->project_url, result->name);
-                    if (state_result) {
-                        state_result->project->get_name(project_name);
-                        strProjectName = wxString(project_name.c_str());
+                    if (task) {
+                        RESULT* state_result = pDoc->state.lookup_result(task->project_url, task->name);
+                        if (state_result) {
+                            state_result->project->get_name(project_name);
+                        }
                     }
-                    fProgress = floor(result->fraction_done*10000)/100;
+                    fProgress = floor(task->fraction_done*10000)/100;
+                
+                    strBuffer.Printf(wxT("\n%s: %.2f%%"), project_name.c_str(), fProgress );
+                    strMessage += strBuffer;
+                    i++;
                 }
-
-                strBuffer.Printf(_("%s: %.2f%% completed\n"), strProjectName.c_str(), fProgress );
+            } else {
+                strBuffer.Printf(_("\n%d running tasks."), tasks.size());
                 strMessage += strBuffer;
             }
+
         } else if (pDoc->IsReconnecting()) {
             strBuffer.Printf(
-                _("Reconnecting to client.\n")
+                _("\nReconnecting to client.")
             );
             strMessage += strBuffer;
         } else {
             strBuffer.Printf(
-                _("Not connected to a client.\n")
+                _("\nNot connected to a client.")
             );
-            iconIcon = m_iconTaskBarDisconnected;
             strMessage += strBuffer;
         }
 
-        SetIcon(iconIcon, strMessage);
+        // Update the text without affecting the icon:
+        SetTooltip(strMessage);
     }
 }
 
 
+std::vector<RESULT*> CTaskBarIcon::GetRunningTasks(CMainDocument* pDoc) {
+
+    std::vector<RESULT*> results;
+    bool bIsActive, bIsExecuting, bIsDownloaded;
+    
+    int iResultCount = pDoc->GetWorkCount();
+
+    for (int iIndex = 0; iIndex < iResultCount; iIndex++) {
+        RESULT* result = pDoc->result(iIndex);
+
+        if (result) {
+            bIsDownloaded = (result->state == RESULT_FILES_DOWNLOADED);
+            bIsActive     = result->active_task;
+            bIsExecuting  = (result->scheduler_state == CPU_SCHED_SCHEDULED);
+            if (bIsActive && bIsDownloaded && bIsExecuting) {
+                results.push_back(result);
+            }
+        }
+    }
+    return results;
+}
+
+
 void CTaskBarIcon::OnContextMenu(wxTaskBarIconExEvent& WXUNUSED(event)) {
     DisplayContextMenu();
 }

clientgui/BOINCTaskBar.h

@@ -24 +24 @@
 #pragma interface "BOINCTaskBar.cpp"
 #endif
 
+#include "MainDocument.h"
 
 #ifdef __WXMSW__
 #include "msw/taskbarex.h"
@@ -89 +90 @@
     void       ResetTaskBar();
 
     void       DisplayContextMenu();
+    std::vector<RESULT*> GetRunningTasks(CMainDocument* pDoc);
     
     DECLARE_EVENT_TABLE()
 

clientgui/msw/taskbarex.cpp

@@ -172 +172 @@
     return m_iconAdded;
 }
 
+bool wxTaskBarIconEx::SetTooltip(const wxString tip)
+{
+        if (!IsOK())
+            return false;
+
+    memset(&notifyData, 0, sizeof(notifyData));
+    notifyData.cbSize           = sizeof(notifyData);
+    notifyData.hWnd             = (HWND) m_hWnd;
+    notifyData.uID              = 99;
+    notifyData.uCallbackMessage = sm_taskbarMsg;
+    notifyData.uFlags           = NIF_TIP;
+    notifyData.uVersion         = NOTIFYICON_VERSION;
+
+    lstrcpyn(notifyData.szTip, WXSTRINGCAST tip, sizeof(notifyData.szTip));
+
+    UpdateIcon();
+    return m_iconAdded;
+}
+
 bool wxTaskBarIconEx::RemoveIcon()
 {
     if (!m_iconAdded)

clientgui/msw/taskbarex.h

@@ -57 +57 @@
         unsigned int iconballoon = NIIF_INFO
     );
 
+    bool SetTooltip(const wxString tip);
     bool RemoveIcon();
     void UpdateIcon();