Issue 1672 - Subscribe and listen COM events using ATL::IDispEventImpl and BEGIN_SINK_MAP

src/plugin/PluginClass.cpp

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 26 matching lines @@
 #ifdef DEBUG_HIDE_EL
 DWORD profileTime = 0;
 #endif
 
 typedef HANDLE (WINAPI *OPENTHEMEDATA)(HWND, LPCWSTR);
 typedef HRESULT (WINAPI *DRAWTHEMEBACKGROUND)(HANDLE, HDC, INT, INT, LPRECT, LPRECT);
 typedef HRESULT (WINAPI *CLOSETHEMEDATA)(HANDLE);
 
 HICON CPluginClass::s_hIcons[ICON_MAX] = { NULL, NULL, NULL };
 DWORD CPluginClass::s_hIconTypes[ICON_MAX] = { IDI_ICON_DISABLED, IDI_ICON_ENABLED, IDI_ICON_DEACTIVATED };
+uint32_t iconHeight = 32;
+uint32_t iconWidth = 32;
 
 CPluginMimeFilterClient* CPluginClass::s_mimeFilter = NULL;
 
 CLOSETHEMEDATA pfnClose = NULL;
 DRAWTHEMEBACKGROUND pfnDrawThemeBackground = NULL;
 OPENTHEMEDATA pfnOpenThemeData = NULL;
 
 ATOM CPluginClass::s_atomPaneClass = NULL;
 HINSTANCE CPluginClass::s_hUxtheme = NULL;
 std::set<CPluginClass*> CPluginClass::s_instances;
@@ skipping 202 matching lines @@
         if (SUCCEEDED(hr))
         {
           m_isAdvised = true;
           try
           {
             std::thread startInitObjectThread(StartInitObject, this);
             startInitObjectThread.detach(); // TODO: but actually we should wait for the thread in the dtr.
           }
           catch (const std::system_error& ex)
           {
-            auto errDescription = std::string("Class::Thread - Failed to create StartInitObject thread, ") +
-              ex.code().message() + ex.what();
-            DEBUG_ERROR_LOG(ex.code().value(), PLUGIN_ERROR_THREAD, PLUGIN_ERROR_MAIN_THREAD_CREATE_PROCESS, errDescription.c_str());
+            DEBUG_SYSTEM_EXCEPTION(ex, PLUGIN_ERROR_THREAD, PLUGIN_ERROR_MAIN_THREAD_CREATE_PROCESS, 
+              "Class::Thread - Failed to create StartInitObject thread");
           }
         }
         else
         {
-          DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_ADVICE, "Class::SetSite - Advice");
+          DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_ADVICE, "Class::SetSite - Advise");
         }
       }
       else // Check if loaded as toolbar handler
       {
         DEBUG_GENERAL("Loaded as toolbar handler");
         CComPtr<IServiceProvider> pServiceProvider;
 
         HRESULT hr = unknownSite->QueryInterface(&pServiceProvider);
         if (SUCCEEDED(hr))
         {
@@ skipping 16 matching lines @@
             }
             s_criticalSectionBrowser.Unlock();
           }
         }
         else
         {
           DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_QUERY_SERVICE_PROVIDER, "Class::SetSite - QueryInterface (service provider)");
         }
       }
     }
-    catch (std::runtime_error e)
-    {
-      DEBUG_ERROR(e.what());
+    catch (const std::runtime_error& ex)
+    {
+      DEBUG_EXCEPTION(ex);
       Unadvise();
     }
   }
   else
   {
     Unadvise();
 
     // Destroy window
     if (m_pWndProcStatus)
     {
@@ skipping 155 matching lines @@
     else
     {
       DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_GET_STATUSBAR, "Class::Get statusbar state");
     }
   }
   DEBUG_GENERAL("ShowStatusBar end");
 }
 
 // Entry point
 void STDMETHODCALLTYPE CPluginClass::OnBeforeNavigate2(
-                        /* [in] */ IDispatch* frameBrowserDisp,

[Oleksandr, 2015/03/12 05:10:57]

Since we do have Doxygen set up, how about using
/**< [in] */ instead of /* [in] */

[Oleksandr, 2015/03/13 16:42:03]

So how about this comment?

[sergei, 2015/03/13 17:03:14]

I've tested it, neither /* [in] */ nor /**< [in] */ are recognized by doxygen
(1.8.9.1).

Actually, I could remove it, should I remove them?

-                        /* [in] */ VARIANT* urlVariant,
-                        /* [in] */ VARIANT* /*Flags*/,
-                        /* [in] */ VARIANT* /*TargetFrameName*/,
-                        /* [in] */ VARIANT* /*PostData*/,
-                        /* [in] */ VARIANT* /*Headers*/,
-                        /* [in, out] */ VARIANT_BOOL* /*Cancel*/)
+  /* [in] */ IDispatch* frameBrowserDisp,
+  /* [in] */ VARIANT* urlVariant,
+  /* [in] */ VARIANT* /*Flags*/,
+  /* [in] */ VARIANT* /*TargetFrameName*/,
+  /* [in] */ VARIANT* /*PostData*/,
+  /* [in] */ VARIANT* /*Headers*/,
+  /* [in, out] */ VARIANT_BOOL* /*Cancel*/)
 {
   try
   {
     ATL::CComQIPtr<IWebBrowser2> webBrowser = frameBrowserDisp;
     if (!webBrowser)
     {
       return;
     }
-
     if (!urlVariant || urlVariant->vt != VT_BSTR)
     {
       return;
     }
     std::wstring url(urlVariant->bstrVal, SysStringLen(urlVariant->bstrVal));
     UnescapeUrl(url);
 
     //Register a mime filter if it's not registered yet
     if (s_mimeFilter == nullptr)
     {
       s_mimeFilter = CPluginClientFactory::GetMimeFilterClientInstance();
     }
-
-    // If webbrowser2 is equal to top level browser (as set in SetSite), we are navigating new page
+    // If webbrowser2 is equal to top level browser (as set in SetSite), we are
+    // navigating new page
     CPluginClient* client = CPluginClient::GetInstance();
-
     if (url.find(L"javascript") == 0)
     {
     }
     else if (GetBrowser().IsEqualObject(webBrowser))
     {
       m_tab->OnNavigate(url);
-      CString urlLegacy = ToCString(url);
-      DEBUG_GENERAL(L"================================================================================\nBegin main navigation url:" + urlLegacy + "\n================================================================================")
-  #ifdef ENABLE_DEBUG_RESULT
-      CPluginDebug::DebugResultDomain(urlLegacy);
-  #endif
+      DEBUG_GENERAL(
+      L"================================================================================\n"
+      L"Begin main navigation url:" + url + L"\n"
+      L"================================================================================")
+
+#ifdef ENABLE_DEBUG_RESULT
+      CPluginDebug::DebugResultDomain(url);
+#endif
       UpdateStatusBar();
     }
     else
     {
-      DEBUG_NAVI(L"Navi::Begin navigation url:" + ToCString(url))
+      DEBUG_NAVI(L"Navi::Begin navigation url:" + url)
       m_tab->CacheFrame(url);
     }
   }
   catch (...)
   {
   }
 }
 
 // Entry point
 void STDMETHODCALLTYPE CPluginClass::OnDownloadComplete()
 {
   try
   {
-    DEBUG_NAVI("Navi::Download Complete")
+    DEBUG_NAVI(L"Navi::Download Complete")
     ATL::CComPtr<IWebBrowser2> browser = GetBrowser();
     if (browser)
     {
       m_tab->OnDownloadComplete(browser);
     }
   }
   catch (...)
   {
   }
 }
 
 // Entry point
 void STDMETHODCALLTYPE CPluginClass::OnDocumentComplete(IDispatch* frameBrowserDisp, VARIANT* /*urlOrPidl*/)
 {
   try
   {
+    DEBUG_NAVI(L"Navi::Document Complete");
     ATL::CComQIPtr<IWebBrowser2> webBrowser2 = frameBrowserDisp;
     if (!webBrowser2)
     {
       return;
     }
     std::wstring frameSrc = GetLocationUrl(*webBrowser2);
     UnescapeUrl(frameSrc);
     bool isRootPageBrowser = GetBrowser().IsEqualObject(webBrowser2);
     m_tab->OnDocumentComplete(webBrowser2, frameSrc, isRootPageBrowser);
   }
   catch (...)
   {
   }
 }
 
 // Entry point
 void STDMETHODCALLTYPE CPluginClass::OnWindowStateChanged(unsigned long flags, unsigned long validFlagsMask)
 {
   try
   {
-    DEBUG_GENERAL("WindowStateChanged (check tab changed)");
+    DEBUG_GENERAL(L"WindowStateChanged (check tab changed)");
     bool newtabshown = validFlagsMask == (OLECMDIDF_WINDOWSTATE_USERVISIBLE | OLECMDIDF_WINDOWSTATE_ENABLED)
-                    && flags == (OLECMDIDF_WINDOWSTATE_USERVISIBLE | OLECMDIDF_WINDOWSTATE_ENABLED);
+      && flags == (OLECMDIDF_WINDOWSTATE_USERVISIBLE | OLECMDIDF_WINDOWSTATE_ENABLED);
     if (newtabshown)
     {
       std::map<DWORD,CPluginClass*>::const_iterator it = s_threadInstances.find(GetCurrentThreadId());
       if (it == s_threadInstances.end())
       {
         s_threadInstances[::GetCurrentThreadId()] = this;
         if (!m_isInitializedOk)
         {
           m_isInitializedOk = true;
           InitObject(true);
           UpdateStatusBar();
         }
       }
     }
     notificationMessage.Hide();
-    DEBUG_GENERAL("WindowStateChanged (check tab changed) end");
+    DEBUG_GENERAL(L"WindowStateChanged (check tab changed) end");
   }
   catch (...)
   {
   }
 }
 
 // Entry point
 void STDMETHODCALLTYPE CPluginClass::OnCommandStateChange(long /*command*/, VARIANT_BOOL /*enable*/)
 {
   try
   {
     if (m_hPaneWnd == NULL)
     {
       CreateStatusBarPane();
     }
     else
     {
       if (AdblockPlus::IE::InstalledMajorVersion() > 6)
       {
         RECT rect;
-        BOOL rectRes = GetClientRect(m_hStatusBarWnd, &rect);
+        //Get the RECT for the leftmost pane (the status text pane)
+        BOOL rectRes = ::SendMessage(m_hStatusBarWnd, SB_GETRECT, 0, (LPARAM)&rect);
         if (rectRes == TRUE)
         {
-          MoveWindow(m_hPaneWnd, rect.right - 200, 0, m_nPaneWidth, rect.bottom - rect.top, TRUE);
-        }
-      }
-    }
+          MoveWindow(m_hPaneWnd, rect.right - m_nPaneWidth, 0, m_nPaneWidth, rect.bottom - rect.top, TRUE);
+        }
+      }
+    }
+  }
+  catch (...)
+  {
+  }
+}
+
+// Entry point
+void STDMETHODCALLTYPE CPluginClass::OnOnQuit()
+{
+  try
+  {
+    Unadvise();
   }
   catch (...)
   {
   }
 }
 
 bool CPluginClass::InitObject(bool bBHO)
 {
   DEBUG_GENERAL("InitObject");
   CPluginSettings* settings = CPluginSettings::GetInstance();
@@ skipping 207 matching lines @@
     DEBUG_ERROR_LOG(0, PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_NO_STATUSBAR_WIN, "Class::CreateStatusBarPane - No status bar")
     return true;
   }
 
   // Calculate pane height
   AdblockPlus::Rectangle rcStatusBar;
   ::GetClientRect(hWndStatusBar, &rcStatusBar);
 
   if (rcStatusBar.Height() > 0)
   {
+    if (rcStatusBar.Height() < iconWidth)
+    { 
+      iconWidth = 19;
+      iconHeight = 19;
+    }
+
 #ifdef _DEBUG
     m_nPaneWidth = 70;
 #else
-    m_nPaneWidth = min(rcStatusBar.Height(), 22);
+    m_nPaneWidth = min(rcStatusBar.Height(), iconWidth);
 #endif
   }
   else
   {
 #ifdef _DEBUG
     m_nPaneWidth = 70;
 #else
-    m_nPaneWidth = 22;
+    m_nPaneWidth = iconWidth;
 #endif
   }
   // Create pane window
   HWND hWndNewPane = ::CreateWindowEx(
     NULL,
     MAKEINTATOM(GetAtomPaneClass()),
     L"",
     WS_CHILD | WS_VISIBLE | WS_CLIPSIBLINGS | WS_CLIPCHILDREN,
-    rcStatusBar.Width() - 500,0,m_nPaneWidth,rcStatusBar.Height(),
+    rcStatusBar.Width() - 500, 0, m_nPaneWidth, rcStatusBar.Height(),
     hWndStatusBar,
     (HMENU)3671,
     _Module.m_hInst,
     NULL);
 
   if (!hWndNewPane)
   {
     DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_CREATE_STATUSBAR_PANE, "Class::CreateStatusBarPane - CreateWindowEx")
     return false;
   }
@@ skipping 585 matching lines @@
             }
           }
         }
       }
 
       // Draw icon
       if (CPluginClient::GetInstance())
       {
         HICON hIcon = GetStatusBarIcon(pClass->GetTab()->GetDocumentUrl());
 
-        int offx = (rcClient.Height() - 16)/2 + nDrawEdge;
+        int offx = nDrawEdge;
         if (hIcon)
         {
-          ::DrawIconEx(hDC, offx, (rcClient.Height() - 16)/2 + 2, hIcon, 16, 16, NULL, NULL, DI_NORMAL);
-          offx += 22;
+          //Get the RECT for the leftmost pane (the status text pane)
+          RECT rect;
+          BOOL rectRes = ::SendMessage(pClass->m_hStatusBarWnd, SB_GETRECT, 0, (LPARAM)&rect);
+          ::DrawIconEx(hDC, 0, rect.bottom - rect.top - iconHeight, hIcon, iconWidth, iconHeight, NULL, NULL, DI_NORMAL);
+          offx += iconWidth;
         }
 #ifdef _DEBUG
         // Display version
         HFONT hFont = (HFONT)::SendMessage(pClass->m_hStatusBarWnd, WM_GETFONT, 0, 0);
         HGDIOBJ hOldFont = ::SelectObject(hDC,hFont);
 
         AdblockPlus::Rectangle rcText = rcClient;
         rcText.left += offx;
         ::SetBkMode(hDC, TRANSPARENT);
         ::DrawTextW(hDC, IEPLUGIN_VERSION, -1, &rcText, DT_WORD_ELLIPSIS|DT_LEFT|DT_SINGLELINE|DT_VCENTER);
@@ skipping 116 matching lines @@
   if (m_hPaneWnd == NULL)
   {
     CreateStatusBarPane();
   }
   if ((m_hPaneWnd != NULL) && !::InvalidateRect(m_hPaneWnd, NULL, FALSE))
   {
       DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_INVALIDATE_STATUSBAR, "Class::Invalidate statusbar");
   }
 }
 
-// Entry point
-void STDMETHODCALLTYPE CPluginClass::OnOnQuit()
-{
-  try
-  {
-    Unadvise();
-  }
-  catch (...)
-  {
-  }
-}
 
 void CPluginClass::Unadvise()
 {
   s_criticalSectionLocal.Lock();
   {
     if (m_isAdvised)
     {
       HRESULT hr = DispEventUnadvise(GetBrowser());
       if (FAILED(hr))
       {
         DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_UNADVISE, "Class::Unadvise - Unadvise");
       }
       m_isAdvised = false;
     }
   }
   s_criticalSectionLocal.Unlock();
 }
 
 HICON CPluginClass::GetIcon(int type)
 {
   HICON icon = NULL;
 
   s_criticalSectionLocal.Lock();
   {
     if (!s_hIcons[type])
     {
-      s_hIcons[type] = ::LoadIcon(_Module.m_hInst, MAKEINTRESOURCE(s_hIconTypes[type]));
+      std::wstring imageToLoad = L"#";
+      imageToLoad += std::to_wstring(s_hIconTypes[type]);
+      s_hIcons[type] = (HICON)::LoadImage(_Module.m_hInst, imageToLoad.c_str(), IMAGE_ICON, iconWidth, iconHeight, LR_SHARED);
       if (!s_hIcons[type])
       {
-        DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_LOAD_ICON, "Class::GetIcon - LoadIcon")
+        DEBUG_ERROR_LOG(::GetLastError(), PLUGIN_ERROR_UI, PLUGIN_ERROR_UI_LOAD_ICON, "Class::GetIcon - LoadIcon");
       }
     }
 
     icon = s_hIcons[type];
   }
   s_criticalSectionLocal.Unlock();
 
   return icon;
 }
 
@@ skipping 62 matching lines @@
           s_criticalSectionLocal.Unlock();
 
         }
       }
     }
 
     hTabWnd = ::GetWindow(hTabWnd, GW_HWNDNEXT);
   }
   return hTabWnd;
 }